Create a customer

POST /customers

Create a customer

Headers

application/json

Body

  • externalId string | null

    Minimum length is 1, maximum length is 255.

  • customerNumber string | null

    Minimum length is 1.

  • email string | null

    Minimum length is 1.

  • firstName string | null

    Minimum length is 1.

  • lastName string | null

    Minimum length is 1.

  • company string | null

    Minimum length is 1.

  • language string | null

    Values are da, de, el, en, es, fr, ja, nl, no, or pl.

  • notes string | null

    Minimum length is 1.

  • phoneNumber string | null

    Minimum length is 1.

  • existing boolean | null

    Default value is false.

  • timeZone string | null

    Minimum length is 1.

  • location object | null

    Additional properties are NOT allowed.

    Hide location attributes Show location attributes object | null
    • postalCode string | null

      Minimum length is 1.

    • countryCode string Required

      Minimum length is 2, maximum length is 2.

    • geolocation object | null

      Additional properties are NOT allowed.

      Hide geolocation attributes Show geolocation attributes object | null
      • latitude number Required

        Minimum value is -90, maximum value is 90.

      • longitude number Required

        Minimum value is -180, maximum value is 180.

    • translations object Required

      Additional properties are NOT allowed.

      Hide translations attributes Show translations attributes object
      • city array[object] Required

        At least 1 element.

        Hide city attributes Show city attributes object
        • language string Required

          Values are da, de, el, en, es, fr, ja, nl, no, or pl.

        • value string Required

          Minimum length is 1.

      • state array[object]

        At least 0 elements.

        Hide state attributes Show state attributes object
        • language string Required

          Values are da, de, el, en, es, fr, ja, nl, no, or pl.

        • value string Required

          Minimum length is 1.

      • street1 array[object] Required

        At least 1 element.

        Hide street1 attributes Show street1 attributes object
        • language string Required

          Values are da, de, el, en, es, fr, ja, nl, no, or pl.

        • value string Required

          Minimum length is 1.

      • street2 array[object]

        At least 0 elements.

        Hide street2 attributes Show street2 attributes object
        • language string Required

          Values are da, de, el, en, es, fr, ja, nl, no, or pl.

        • value string Required

          Minimum length is 1.

Responses

  • 201 application/json

    Successful operation

    Hide response attribute Show response attribute object
    • data object Required

      Additional properties are NOT allowed.

      Hide data attributes Show data attributes object
      • id string Required

        Minimum length is 1.

      • externalId string | null

        Minimum length is 1, maximum length is 255.

      • customerNumber string | null

        Minimum length is 1.

      • email string | null

        Minimum length is 1.

      • firstName string | null

        Minimum length is 1.

      • lastName string | null

        Minimum length is 1.

      • company string | null

        Minimum length is 1.

      • language string | null

        Values are da, de, el, en, es, fr, ja, nl, no, or pl.

      • notes string | null

        Minimum length is 1.

      • phoneNumber string | null

        Minimum length is 1.

      • existing boolean Required
      • timeZone string Required

        Minimum length is 1.

      • createdAt string(date-time) Required

        Minimum length is 1.

      • updatedAt string(date-time) Required

        Minimum length is 1.

      • deletedAt string(date-time) | null Required

        Minimum length is 1.

      • location object | null

        Additional properties are allowed.

        Hide location attributes Show location attributes object | null
        • city object | null Required

          Additional properties are NOT allowed.

          Hide city attributes Show city attributes object | null
          • language string Required

            Values are da, de, el, en, es, fr, ja, nl, no, or pl.

          • value string Required
        • state object | null Required

          Additional properties are NOT allowed.

          Hide state attributes Show state attributes object | null
          • language string Required

            Values are da, de, el, en, es, fr, ja, nl, no, or pl.

          • value string Required
        • street1 object | null Required

          Additional properties are NOT allowed.

          Hide street1 attributes Show street1 attributes object | null
          • language string Required

            Values are da, de, el, en, es, fr, ja, nl, no, or pl.

          • value string Required
        • street2 object | null Required

          Additional properties are NOT allowed.

          Hide street2 attributes Show street2 attributes object | null
          • language string Required

            Values are da, de, el, en, es, fr, ja, nl, no, or pl.

          • value string Required
        • postalCode string | null

          Minimum length is 1.

        • countryCode string Required

          Minimum length is 2, maximum length is 2.

        • formattedAddress string Required

          Minimum length is 1.

        • geolocation object Required

          Additional properties are NOT allowed.

          Hide geolocation attributes Show geolocation attributes object
          • latitude number Required

            Minimum value is -90, maximum value is 90.

          • longitude number Required

            Minimum value is -180, maximum value is 180.

        • translations object Required

          Additional properties are NOT allowed.

          Hide translations attributes Show translations attributes object
          • city array[object] Required

            At least 1 element.

            Hide city attributes Show city attributes object
            • language string Required

              Values are da, de, el, en, es, fr, ja, nl, no, or pl.

            • value string Required

              Minimum length is 1.

          • state array[object]

            At least 0 elements.

            Hide state attributes Show state attributes object
            • language string Required

              Values are da, de, el, en, es, fr, ja, nl, no, or pl.

            • value string Required

              Minimum length is 1.

          • street1 array[object] Required

            At least 1 element.

            Hide street1 attributes Show street1 attributes object
            • language string Required

              Values are da, de, el, en, es, fr, ja, nl, no, or pl.

            • value string Required

              Minimum length is 1.

          • street2 array[object]

            At least 0 elements.

            Hide street2 attributes Show street2 attributes object
            • language string Required

              Values are da, de, el, en, es, fr, ja, nl, no, or pl.

            • value string Required

              Minimum length is 1.

  • 422 application/json

    Business validation failed

    • CUSTOMER_NOT_IDENTIFIABLE
    • LOCATION_GEOCODING_FAILED
    • LOCATION_TIME_ZONE_RESOLUTION_FAILED

    See Error codes

    Hide response attribute Show response attribute object
    • errors array[object] Required

      At least 1 element.

      Hide errors attributes Show errors attributes object
      • message string Required

        Minimum length is 1.

      • code string Required

        Minimum length is 1.

      • type string Required

        Minimum length is 1.

      • statusCode string Required

        Minimum length is 1.

      • arguments object | null

        Additional properties are allowed.

POST /customers
curl \
 -X POST https://api.development.pexipengage.com/enterprises/acme/customers \
 -H "Content-Type: application/json" \
 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 -H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002" \
 -H "Accept-Language: en *" \
 -d '{"externalId":"ABCD1234","customerNumber":"123456","email":"john.doe@pexip.com","firstName":"John","lastName":"Doe","company":"Acme Corp","language":"da","notes":"Lorem ipsum","phoneNumber":"+32412345678","existing":true,"timeZone":"Europe/Brussels","location":{"postalCode":"9000","countryCode":"BE","geolocation":{"latitude":51.0479466,"longitude":3.6912248},"translations":{"city":[{"language":"en","value":"Lorem ipsum"}],"state":[{"language":"en","value":"Lorem ipsum"}],"street1":[{"language":"en","value":"Lorem ipsum"}],"street2":[{"language":"en","value":"Lorem ipsum"}]}}}'
Request examples
# Headers
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002
Accept-Language: en *

# Payload
{
  "externalId": "ABCD1234",
  "customerNumber": "123456",
  "email": "john.doe@pexip.com",
  "firstName": "John",
  "lastName": "Doe",
  "company": "Acme Corp",
  "language": "da",
  "notes": "Lorem ipsum",
  "phoneNumber": "+32412345678",
  "existing": true,
  "timeZone": "Europe/Brussels",
  "location": {
    "postalCode": "9000",
    "countryCode": "BE",
    "geolocation": {
      "latitude": 51.0479466,
      "longitude": 3.6912248
    },
    "translations": {
      "city": [
        {
          "language": "en",
          "value": "Lorem ipsum"
        }
      ],
      "state": [
        {
          "language": "en",
          "value": "Lorem ipsum"
        }
      ],
      "street1": [
        {
          "language": "en",
          "value": "Lorem ipsum"
        }
      ],
      "street2": [
        {
          "language": "en",
          "value": "Lorem ipsum"
        }
      ]
    }
  }
}
Response examples (201)
{
  "data": {
    "id": "123",
    "externalId": "ABCD1234",
    "customerNumber": "123456",
    "email": "john.doe@pexip.com",
    "firstName": "John",
    "lastName": "Doe",
    "company": "Acme Corp",
    "language": "da",
    "notes": "Lorem ipsum",
    "phoneNumber": "+32412345678",
    "existing": true,
    "timeZone": "Europe/Brussels",
    "createdAt": "2022-08-17T19:05:21.362Z",
    "updatedAt": "2022-08-17T19:05:21.362Z",
    "deletedAt": "2022-08-17T19:05:21.362Z",
    "location": {
      "city": {
        "language": "en",
        "value": "Lorem ipsum"
      },
      "state": {
        "language": "en",
        "value": "Lorem ipsum"
      },
      "street1": {
        "language": "en",
        "value": "Lorem ipsum"
      },
      "street2": {
        "language": "en",
        "value": "Lorem ipsum"
      },
      "postalCode": "9000",
      "countryCode": "BE",
      "formattedAddress": "string",
      "geolocation": {
        "latitude": 51.0479466,
        "longitude": 3.6912248
      },
      "translations": {
        "city": [
          {
            "language": "en",
            "value": "Lorem ipsum"
          }
        ],
        "state": [
          {
            "language": "en",
            "value": "Lorem ipsum"
          }
        ],
        "street1": [
          {
            "language": "en",
            "value": "Lorem ipsum"
          }
        ],
        "street2": [
          {
            "language": "en",
            "value": "Lorem ipsum"
          }
        ]
      }
    }
  }
}
Response examples (422)
{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "type": "string",
      "statusCode": "string",
      "arguments": {}
    }
  ]
}