Addresses
Lists the signed-in customer’s saved addresses. A saved address belongs to the customer, never to one store.
Authorization
clientKey customerToken The store's API key (Dashboard → Settings → API keys). pk_live_… public keys are for browser code and only work from an origin on the key's allowlist; sk_live_… private keys are for servers and native apps and need no Origin.
In: header
The customer access credential from any sign-in session answer (access_token). Account operations only — send as Authorization: Bearer <access_token> ALONGSIDE X-Client-Key. It is bound to one store: a credential issued for another vendor answers 403 here.
In: header
Header Parameters
Your store API key (Dashboard → Settings → API keys). pk_live_… public keys are for browser code and only work from an origin on the key's allowlist; sk_live_… private keys are for servers and native apps and need no Origin.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/store/addresses" \ -H "X-Client-Key: {{clientKey}}"{ "status": "success", "message": "Saved addresses retrieved", "data": [ { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5ca1", "label": "Home", "address": "4B Adebayo Doherty Road, Lekki Phase 1, Lagos", "lat": 6.4474, "lng": 3.4712, "country_code": "NG", "state": "Lagos", "city": "Lekki", "area": "Lekki Phase 1", "state_id": 25, "area_id": 377, "is_default": true }, { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5ca2", "label": "Office", "address": "Plot 7, Block 12E Admiralty Way, Lekki Phase 1, Lagos", "lat": 6.4481, "lng": 3.4702, "country_code": "NG", "state": "Lagos", "city": "Lekki", "area": "Lekki Phase 1", "state_id": 25, "area_id": 377, "is_default": false } ]}Saves an address for the signed-in customer.
Authorization
clientKey customerToken The store's API key (Dashboard → Settings → API keys). pk_live_… public keys are for browser code and only work from an origin on the key's allowlist; sk_live_… private keys are for servers and native apps and need no Origin.
In: header
The customer access credential from any sign-in session answer (access_token). Account operations only — send as Authorization: Bearer <access_token> ALONGSIDE X-Client-Key. It is bound to one store: a credential issued for another vendor answers 403 here.
In: header
Header Parameters
Your store API key (Dashboard → Settings → API keys). pk_live_… public keys are for browser code and only work from an origin on the key's allowlist; sk_live_… private keys are for servers and native apps and need no Origin.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/store/addresses" \ -H "X-Client-Key: {{clientKey}}" \ -H "Content-Type: application/json" \ -d '{ "label": "Home", "address": "4B Adebayo Doherty Road, Lekki Phase 1, Lagos", "lat": 6.4474, "lng": 3.4712 }'{ "status": "success", "message": "Address saved", "data": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5ca1", "label": "Home", "address": "4B Adebayo Doherty Road, Lekki Phase 1, Lagos", "lat": 6.4474, "lng": 3.4712, "country_code": "NG", "state": "Lagos", "city": "Lekki", "area": "Lekki Phase 1", "state_id": 25, "area_id": 377, "is_default": true }}Remove a saved address (Address removed). Deleting the default promotes the newest remaining address.
Authorization
clientKey customerToken The store's API key (Dashboard → Settings → API keys). pk_live_… public keys are for browser code and only work from an origin on the key's allowlist; sk_live_… private keys are for servers and native apps and need no Origin.
In: header
The customer access credential from any sign-in session answer (access_token). Account operations only — send as Authorization: Bearer <access_token> ALONGSIDE X-Client-Key. It is bound to one store: a credential issued for another vendor answers 403 here.
In: header
Path Parameters
Header Parameters
Your store API key (Dashboard → Settings → API keys). pk_live_… public keys are for browser code and only work from an origin on the key's allowlist; sk_live_… private keys are for servers and native apps and need no Origin.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/store/addresses/019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5ca2" \ -H "X-Client-Key: {{clientKey}}"{ "status": "success", "message": "Address removed"}Makes one of the customer’s saved addresses the default.
Authorization
clientKey customerToken The store's API key (Dashboard → Settings → API keys). pk_live_… public keys are for browser code and only work from an origin on the key's allowlist; sk_live_… private keys are for servers and native apps and need no Origin.
In: header
The customer access credential from any sign-in session answer (access_token). Account operations only — send as Authorization: Bearer <access_token> ALONGSIDE X-Client-Key. It is bound to one store: a credential issued for another vendor answers 403 here.
In: header
Path Parameters
Header Parameters
Your store API key (Dashboard → Settings → API keys). pk_live_… public keys are for browser code and only work from an origin on the key's allowlist; sk_live_… private keys are for servers and native apps and need no Origin.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/store/addresses/019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5ca1/default" \ -H "X-Client-Key: {{clientKey}}"{ "status": "success", "message": "Default address updated", "data": { "id": "019b0c4d-5e6f-7a8b-9c0d-1e2f3a4b5ca1", "label": "Home", "address": "4B Adebayo Doherty Road, Lekki Phase 1, Lagos", "lat": 6.4474, "lng": 3.4712, "country_code": "NG", "state": "Lagos", "city": "Lekki", "area": "Lekki Phase 1", "state_id": 25, "area_id": 377, "is_default": true }}