Addresses

Retrieving customer addresses

get

Retrieves a list of addresses for a specified customer.

Required scopes

This endpoint requires the following scopes:

: Needed to retrieve customer profiles.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

customerNumberstringRequired

Customer unique identifier generated when the customer profile is created.

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

Responses

200

application/json

Customer address information.

idstringOptional

Customer address unique identifier generated when the address is added to the customer account.

contactNamestringRequired

companyNamestringOptional

streetstringOptional

streetNumberstringOptional

streetAppendixstringOptional

extraLine1stringOptional

extraLine2stringOptional

extraLine3stringOptional

extraLine4stringOptional

zipCodestringOptional

citystringOptional

countrystring · min: 2 · max: 2Optional

statestringOptional

contactPhonestringOptional

isDefaultbooleanOptional

Flag indicating whether the address is the customer default address.

Default: false

tagsstring[]Optional

400

Request was syntactically incorrect. Details will be provided in the response payload.

application/json

401

Unauthorized

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

404

Not Found

get

/customer/{tenant}/customers/{customerNumber}/addresses

GET /customer/{tenant}/customers/{customerNumber}/addresses HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "contactName": "John Doe",
    "companyName": "Emporix",
    "street": "Platz der Republik",
    "streetNumber": "1",
    "streetAppendix": "",
    "extraLine1": "",
    "extraLine2": "",
    "extraLine3": "",
    "extraLine4": "",
    "zipCode": "11011",
    "city": "Berlin",
    "country": "DE",
    "state": "Berlin",
    "contactPhone": "123456789",
    "tags": [
      "BILLING",
      "SHIPPING"
    ],
    "id": "b05c20e034",
    "isDefault": true
  }
]

Adding a customer address

post

Adds an address to a specified customer profile.

Required scopes

This endpoint requires the following scopes:

: Needed to manage customer profiles.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

customerNumberstringRequired

Customer unique identifier generated when the customer profile is created.

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

Body

idstringOptional

Custom customer address identifier. If not provided, it is automatically generated.

contactNamestringRequired

companyNamestringOptional

streetstringOptional

streetNumberstringOptional

streetAppendixstringOptional

extraLine1stringOptional

extraLine2stringOptional

extraLine3stringOptional

extraLine4stringOptional

zipCodestringOptional

citystringOptional

countrystring · min: 2 · max: 2Optional

statestringOptional

contactPhonestringOptional

isDefaultbooleanOptional

Flag indicating whether the address is the customer default address.

Default: false

tagsstring[]Optional

Responses

201

Created

application/json

400

Request was syntactically incorrect. Details will be provided in the response payload.

application/json

401

Unauthorized

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

404

Customer with the specified customerNumber doesn't exist.

application/json

409Error

application/json

post

/customer/{tenant}/customers/{customerNumber}/addresses

POST /customer/{tenant}/customers/{customerNumber}/addresses HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 323

{
  "contactName": "John Doe",
  "companyName": "Emporix",
  "street": "Platz der Republik",
  "streetNumber": "1",
  "streetAppendix": "",
  "extraLine1": "",
  "extraLine2": "",
  "extraLine3": "",
  "extraLine4": "",
  "zipCode": "11011",
  "city": "Berlin",
  "country": "DE",
  "state": "Berlin",
  "contactPhone": "123456789",
  "tags": [
    "BILLING",
    "SHIPPING"
  ],
  "isDefault": true
}

{
  "id": "e6eae2c789"
}

Retrieving a customer address

get

Retrieves a specified customer address and its details.

Required scopes

This endpoint requires the following scopes:

: Needed to retrieve customer profiles.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

addressIdstringRequired

Address unique identifier generated when the address is added to a customer profile.

customerNumberstringRequired

Customer unique identifier generated when the customer profile is created.

tenantstringRequired

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Responses

200

application/json

Customer address information.

idstringOptional

Customer address unique identifier generated when the address is added to the customer account.

contactNamestringRequired

companyNamestringOptional

streetstringOptional

streetNumberstringOptional

streetAppendixstringOptional

extraLine1stringOptional

extraLine2stringOptional

extraLine3stringOptional

extraLine4stringOptional

zipCodestringOptional

citystringOptional

countrystring · min: 2 · max: 2Optional

statestringOptional

contactPhonestringOptional

isDefaultbooleanOptional

Flag indicating whether the address is the customer default address.

Default: false

tagsstring[]Optional

400

Request was syntactically incorrect. Details will be provided in the response payload.

application/json

401

Unauthorized

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

404

The requested resource does not exist.

application/json

get

/customer/{tenant}/customers/{customerNumber}/addresses/{addressId}

GET /customer/{tenant}/customers/{customerNumber}/addresses/{addressId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "contactName": "John Doe",
  "companyName": "Emporix",
  "street": "Platz der Republik",
  "streetNumber": "1",
  "streetAppendix": "",
  "extraLine1": "",
  "extraLine2": "",
  "extraLine3": "",
  "extraLine4": "",
  "zipCode": "11011",
  "city": "Berlin",
  "country": "DE",
  "state": "Berlin",
  "contactPhone": "123456789",
  "tags": [
    "BILLING",
    "SHIPPING"
  ],
  "id": "b05c20e034",
  "isDefault": true
}

Upserting a customer address

put

Updates a specified customer address or creates a new one if it doesn't exist yet.

Required scopes

This endpoint requires the following scopes:

: Needed to manage customer profiles.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

addressIdstringRequired

Address unique identifier generated when the address is added to a customer profile.

customerNumberstringRequired

Customer unique identifier generated when the customer profile is created.

tenantstringRequired

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Body

Responses

201

Created

application/json

204

No Content - update has been successful

400

Request was syntactically incorrect. Details will be provided in the response payload.

application/json

401

Unauthorized

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

404

The requested resource does not exist.

application/json

put

/customer/{tenant}/customers/{customerNumber}/addresses/{addressId}

PUT /customer/{tenant}/customers/{customerNumber}/addresses/{addressId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 323

{
  "contactName": "John Doe",
  "companyName": "Emporix",
  "street": "Platz der Republik",
  "streetNumber": "1",
  "streetAppendix": "",
  "extraLine1": "",
  "extraLine2": "",
  "extraLine3": "",
  "extraLine4": "",
  "zipCode": "11011",
  "city": "Berlin",
  "country": "DE",
  "state": "Berlin",
  "contactPhone": "123456789",
  "tags": [
    "BILLING",
    "SHIPPING"
  ],
  "isDefault": true
}

{
  "id": "e6eae2c789"
}

Deleting a customer address

delete

Deletes a specified customer address.

Required scopes

This endpoint requires the following scopes:

: Needed to manage customer profiles.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

addressIdstringRequired

Address unique identifier generated when the address is added to a customer profile.

customerNumberstringRequired

Customer unique identifier generated when the customer profile is created.

tenantstringRequired

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Body

objectOptional

Responses

204

No Content

400

Request was syntactically incorrect. Details will be provided in the response payload.

application/json

401

Unauthorized

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

404

The requested resource does not exist.

application/json

delete

/customer/{tenant}/customers/{customerNumber}/addresses/{addressId}

DELETE /customer/{tenant}/customers/{customerNumber}/addresses/{addressId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

No content

Partially updating a customer address

patch

Updates a specified customer address.

Required scopes

This endpoint requires the following scopes:

: Needed to manage customer profiles.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

addressIdstringRequired

Address unique identifier generated when the address is added to a customer profile.

customerNumberstringRequired

Customer unique identifier generated when the customer profile is created.

tenantstringRequired

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Body

Responses

200

No content

400

Request was syntactically incorrect. Details will be provided in the response payload.

application/json

401

Unauthorized

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

404

The requested resource does not exist.

application/json

patch

/customer/{tenant}/customers/{customerNumber}/addresses/{addressId}

PATCH /customer/{tenant}/customers/{customerNumber}/addresses/{addressId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 323

{
  "contactName": "John Doe",
  "companyName": "Emporix",
  "street": "Platz der Republik",
  "streetNumber": "1",
  "streetAppendix": "",
  "extraLine1": "",
  "extraLine2": "",
  "extraLine3": "",
  "extraLine4": "",
  "zipCode": "11011",
  "city": "Berlin",
  "country": "DE",
  "state": "Berlin",
  "contactPhone": "123456789",
  "tags": [
    "BILLING",
    "SHIPPING"
  ],
  "isDefault": true
}

No content

Adding tags to a customer address

post

Adds tags to a specified customer address.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

addressIdstringRequired

Address unique identifier generated when the address is added to a customer profile.

customerNumberstringRequired

Customer unique identifier generated when the customer profile is created.

tenantstringRequired

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Query parameters

tagsstringRequired

List of address tags, separated by commas.

Example: BILLING,SHIPPING

Responses

204

No Content

400

Request was syntactically incorrect. Details will be provided in the response payload.

application/json

401

Unauthorized

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

404

The requested resource does not exist.

application/json

post

/customer/{tenant}/customers/{customerNumber}/addresses/{addressId}/tags

POST /customer/{tenant}/customers/{customerNumber}/addresses/{addressId}/tags?tags=BILLING%2CSHIPPING HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Deleting tags from a customer address

delete

Deletes tags from a specified customer address.

Required scopes

This endpoint requires the following scopes:

: Needed to manage customer profiles.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

addressIdstringRequired

Address unique identifier generated when the address is added to a customer profile.

customerNumberstringRequired

Customer unique identifier generated when the customer profile is created.

tenantstringRequired

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Query parameters

tagsstringRequired

List of address tags, separated by commas.

Example: BILLING,SHIPPING

Responses

204

No Content

400

Request was syntactically incorrect. Details will be provided in the response payload.

application/json

401

Unauthorized

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

404

The requested resource does not exist.

application/json

delete

/customer/{tenant}/customers/{customerNumber}/addresses/{addressId}/tags

DELETE /customer/{tenant}/customers/{customerNumber}/addresses/{addressId}/tags?tags=BILLING%2CSHIPPING HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

PreviousAccount and profile NextModels

Last updated 7 days ago

Was this helpful?

Good afternoon

hashtagRetrieving customer addresses

hashtagAdding a customer address

hashtagRetrieving a customer address

hashtagUpserting a customer address

hashtagDeleting a customer address

hashtagPartially updating a customer address

hashtagAdding tags to a customer address

hashtagDeleting tags from a customer address

Retrieving customer addresses

Adding a customer address

Retrieving a customer address

Upserting a customer address

Deleting a customer address

Partially updating a customer address

Adding tags to a customer address

Deleting tags from a customer address