Addresses
Customer's unique identifier generated when the customer's profile is created.
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$
OK
Request was syntactically incorrect. Details will be provided in the response payload.
Unauthorized
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.
Not Found
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
}
]
Customer's unique identifier generated when the customer's profile is created.
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$
Custom customer's address identifier. If not provided, it is automatically generated.
Flag indicating whether the address is the customer's default address.
false
Created
Request was syntactically incorrect. Details will be provided in the response payload.
Unauthorized
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.
Customer with the specified customerNumber
doesn't exist.
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"
}
Address' unique identifier generated when the address is added to a customer's profile.
Customer's unique identifier generated when the customer's profile is created.
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
OK
Request was syntactically incorrect. Details will be provided in the response payload.
Unauthorized
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.
The requested resource does not exist.
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
}
Address' unique identifier generated when the address is added to a customer's profile.
Customer's unique identifier generated when the customer's profile is created.
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
Created
No Content - update has been successful
Request was syntactically incorrect. Details will be provided in the response payload.
Unauthorized
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.
The requested resource does not exist.
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"
}
Address' unique identifier generated when the address is added to a customer's profile.
Customer's unique identifier generated when the customer's profile is created.
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
No Content
Request was syntactically incorrect. Details will be provided in the response payload.
Unauthorized
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.
The requested resource does not exist.
DELETE /customer/{tenant}/customers/{customerNumber}/addresses/{addressId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Address' unique identifier generated when the address is added to a customer's profile.
Customer's unique identifier generated when the customer's profile is created.
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
OK
Request was syntactically incorrect. Details will be provided in the response payload.
Unauthorized
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.
The requested resource does not exist.
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
Address' unique identifier generated when the address is added to a customer's profile.
Customer's unique identifier generated when the customer's profile is created.
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
List of address tags, separated by commas.
BILLING,SHIPPING
No Content
Request was syntactically incorrect. Details will be provided in the response payload.
Unauthorized
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.
The requested resource does not exist.
POST /customer/{tenant}/customers/{customerNumber}/addresses/{addressId}/tags HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Address' unique identifier generated when the address is added to a customer's profile.
Customer's unique identifier generated when the customer's profile is created.
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
List of address tags, separated by commas.
BILLING,SHIPPING
No Content
Request was syntactically incorrect. Details will be provided in the response payload.
Unauthorized
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.
The requested resource does not exist.
DELETE /customer/{tenant}/customers/{customerNumber}/addresses/{addressId}/tags HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Was this helpful?