GET
View a customer address
Company space For: Cashier and seller, Manager · Permission: customer_addresses.retrieve 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).

address
string
required

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

Query Parameters

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

200 - application/json

Resource.

id

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

customer_id

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

label

Short name of the address, unique among the addresses of the same customer.

address

Free-text address.

city

City, or null when none was given.

phone_number

Contact phone number for this address, or null when none was given.

latitude

Latitude in decimal degrees, between -90 and 90, with up to 7 decimals. Returned as a decimal string. Null when none was given.

longitude

Longitude in decimal degrees, between -180 and 180, with up to 7 decimals. Returned as a decimal string. Null when none was given.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).