Skip to content

Address

The authenticated user’s shipping address (for product samples). At most one per user.

OperationMethod + pathToken scopeRoleNotes
Show addressGET /me/address.jsonread or writeAuthenticated userReturns 404 if no address exists yet
Create or update addressPATCH /me/address.jsonwriteAuthenticated userSame endpoint upserts
Delete addressDELETE /me/address.jsonwriteAuthenticated userReturns 204 No Content
{
"id": "wDcVbN",
"address_one": "1 Infinite Loop",
"address_two": null,
"city": "Cupertino",
"state": "CA",
"postal_code": "95014",
"country_code": "US",
"created_at": "2026-04-01T10:00:00Z",
"updated_at": "2026-04-01T10:00:00Z"
}
GET /me/address.json

Returns the user’s address, or 404 Not Found if the user hasn’t set one.

PATCH /me/address.json
{
"address": {
"address_one": "1 Infinite Loop",
"city": "Cupertino",
"state": "CA",
"postal_code": "95014",
"country_code": "US"
}
}

Same endpoint creates the address if missing, updates it otherwise. Requires a write-scoped token. Returns 200 OK with the address.

DELETE /me/address.json

Removes the address. Returns 204 No Content. The user can later re-create it.

CodeWhen
401Missing token, or read token attempting a write
404No address has been set yet (on GET)
422Validation failed