Skip to main content

Add Customer Address

POST {{baseUrl}}/customers/addresses/{customerId}

Parameters​

  • tenantId (string, header, required): The ID of the tenant.
  • customerId (string, path, required): The ID of the customer.

Request Body​

Media Type: application/json​

Example Value​

{
"state": "string",
"city": "string",
"address": "string",
"longitude": 0,
"latitude": 0,
"postalCode": "string",
"deliveryMode": "PICK_UP",
"customerPhoneNumber": "string"
}

Schema​

NameTypeDescription
statestringThe state of the customer's address.
citystringThe city of the customer's address.
addressstringThe detailed address of the customer.
longitudenumberThe longitude of the customer's address.
latitudenumberThe latitude of the customer's address.
postalCodestringThe postal code of the customer's address.
deliveryModestringThe delivery mode, e.g., "PICK_UP".
customerPhoneNumberstringThe phone number of the customer.

Responses​

200 OK​

Media Type: application/json​

Example​

{
"message": "string",
"data": {
"id": "string",
"state": "string",
"city": "string",
"address": "string",
"latitude": 0,
"longitude": 0,
"customerId": "string",
"tenantId": "string",
"postalCode": "string",
"deliveryMode": "PICK_UP",
"customerPhoneNumber": "string"
},
"meta": {
"currentPage": 0,
"from": 0,
"to": 0,
"perPage": 0,
"total": 0,
"lastPage": 0
}
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request POST \ 
--url /customers/addresses/ \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


Click Try It! to start a request and see the response here!