GET
List customer addresses
Company space For: Cashier and seller, Manager · Permission: customer_addresses.list Part of Manage customers.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customer
string
required

Identifier of the customer (27-character KSUID string).

Query Parameters

per_page
integer

Number of items per page.

Required range: 1 <= x <= 100
cursor
string

Position in the list. Pass the meta.next_cursor or meta.prev_cursor value of the previous page; leave it out to get the first page.

sort_by
enum<string>

Field the list is sorted by.

Available options:
id,
label,
created_at,
updated_at
sort_order
enum<string>

asc for ascending order, desc for descending order.

Available options:
asc,
desc
response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, customer_id, label, address, city, phone_number, latitude, longitude, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Response

Resource.

data
CustomerAddressResource · object[]
required

Items of this page.

meta
object
required

Pagination details.