Headers

• Authorization string

  Bearer token used for authorization

  Minimum length is 1.

• X-Correlation-Id string

  Unique identifier to allow referencing a particular transaction or event chain

  Minimum length is 1.

• Accept-Language string

  Returns the requested resources translated according to the passed languages (see translatable resources)

  Minimum length is 1.

Path parameters

• id string Required

  Primary identifier of the requested resource

  Minimum length is 1.

Responses

• 200 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
      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.

• 404 application/json

  Resource not found

  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.

• 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