🔒 Paginated list of delivery addresses for a customer V3

get

https://{xentralId}.xentral.biz/api/v3/customers/{customerId}/deliveryAddresses

This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.

This endpoint requires the following scopes: customer:read.

Paginated list of delivery addresses for a customer.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

customerId

string

required

Query Params

filter

array of objects

The filter parameter is used to filter the results of the given endpoint.

Supported filter operators by key:

deliveryAddress.name: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

deliveryAddress.title: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

deliveryAddress.contactPerson: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

deliveryAddress.department: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

deliveryAddress.subDepartment: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

deliveryAddress.addressSupplement: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

deliveryAddress.street: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

deliveryAddress.zipCode: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

deliveryAddress.city: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

deliveryAddress.state: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

deliveryAddress.country: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

deliveryAddress.gln: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

deliveryAddress.email: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

deliveryAddress.phone: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

deliveryAddress.fax: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

taxType: equals, notEquals, in, notIn

defaultDeliveryAddress: equals, notEquals

termsOfDelivery: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

vatId: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

remark: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

note: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

id: equals, notEquals, in, notIn, isNull, isNotNull

filter

sort

array

Sort via id, -id, name, -name, city, -city, country, -country, zipCode and -zipCode. Default sort is -created_at

sort

perPage

integer

≥ 0

Number of items per page. Default: 15, Max: 100. A larger value is reduced to the maximum; omitting it or sending 0 selects the default.

page

integer

≥ 0

Page number. Only used with simple and table pagination. Omitting it or sending 0 selects the first page.

cursor

string

The cursor to use for the paginated call. Only used with cursor pagination. Not compatible with page parameter

Headers

x-pagination

string

enum

Controls the pagination format. Available types: simple, table, cursor. Defaults to 'simple' if not specified.

Allowed:

Responses

401

Unauthorized

403

Forbidden

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Paginated list of delivery addresses for a customer.

429Too Many Requests