v1

latestOpenAPI 3.0.02026-07-2455104.8 MB

Customer Address

List addresses

Fetches a list of addresses that belong to specified customer. The list includes the main address (type=masterdata), billing address (type=billingaddress) and all delivery addresses (type=deliveryaddress).

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

Path parameters

customerIdstring required

Resource identifier.

Example:17

The customer's identifier.

Query parameters

key'type'

op'equals' | 'notEquals' | 'in' | 'notIn'

value'masterdata' | 'billingaddress' | 'deliveryaddress'

numberstring required

Page number should be an integer greater than or equal to 1

sizestring required

Page size should usually be an integer between 10 and 50.

Use either page-based or cursor-based pagination, but not both.

Response

List of customer's addresses

Example response

{
  "data": [
    {
      "id": "masterdata",
      "type": "masterdata",
      "name": "John Doe",
      "street": "1234 street",
      "addressSupplement": "5th floor",
      "department": "Financial & Accounting",
      "subDepartment": "Purchase accounting",
      "zip": "12345",
      "city": "Sampletown",
      "country": "DE",
      "state": "BY"
    }
  ],
  "extra": {
    "totalCount": 1,
    "page": {
      "number": 1,
      "size": 10
    }
  },
  "links": {
    "self": "/api/v2/customers/1234/addresses?page%5Bnumber%5D=2&page%5Bsize%5D=10",
    "next": "/api/v2/customers/1234/addresses?page%5Bnumber%5D=3&page%5Bsize%5D=10",
    "prev": "/api/v2/customers/1234/addresses?page%5Bnumber%5D=1&page%5Bsize%5D=10",
    "customer": "/api/v2/customers/1234"
  }
}