Sign in

v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Customer Address

View address

Returns details of a single customer address

get/api/v2/customers/{customerId}/addresses/{id}

Path parameters

customerIdstring required

Resource identifier.

Example:17

The customer's identifier.

'masterdata' | 'billingaddress' required
OR
string required

Resource identifier.

Example:17

The address identifier. Can be masterdata, billingaddress, or a numeric ID (which corresponds to a delivery address).

Response

Customer address response object

Example response

{
  "data": {
    "id": "1",
    "type": "deliveryaddress",
    "name": "Test delivery address",
    "street": "1",
    "zip": "12345",
    "city": "Munich",
    "country": "DE",
    "state": "BY",
    "addressSupplement": "1",
    "department": "Department",
    "subDepartment": "Subdepartment",
    "contactDetails": {
      "email": "dev@xentral.com",
      "phone": "+49(0) 174406668",
      "gln": "1234567890123"
    },
    "deliveryDetails": {
      "taxType": "export",
      "defaultDeliveryAddress": false,
      "termsOfDelivery": " Delivery term",
      "vatId": "123213212",
      "internalComment": "my awesome delivery internal comment",
      "note": "my awesome delivery notice"
    }
  },
  "links": {
    "links": {
      "self": "http://localhost/api/v2/customers/2/addresses/1",
      "customer": "http://localhost/api/v2/customers/2"
    }
  }
}