Skip to content

Get an address

GET
/tenant/stores/{storeRef}/customers/address/{addressId}
curl --request GET \
--url https://apibase.ecomweb.app/api/v1/tenant/stores/example/customers/address/1 \
--header 'Authorization: Bearer <token>' \
--header 'x-storefront-api-key: <x-storefront-api-key>'

Returns one saved address of the signed-in shopper. Returns 403 when the address belongs to another customer and 404 when it does not exist.

addressId
required
number

The address ID, as returned when the address was created or listed.

storeRef
required
string

The store’s ref, as returned by GET /stores.

Media typeapplication/json
object
id
required

Address ID.

number
customer_id
required

ID of the customer the address belongs to.

number
label

A short label such as Home or Office, or null.

string
nullable
recipient_name
required

Name of the person receiving deliveries.

string
phone_number
required

Contact phone number.

string
address_line1
required

First address line.

string
address_line2

Second address line, or null.

string
nullable
ward
required

Ward code.

string
ward_name

Ward name, when it can be resolved from the code.

string
district

District, or null.

string
nullable
city

City, or null.

string
nullable
province
required

Province code.

string
province_name

Province name, when it can be resolved from the code.

string
postal_code

Postal code, or null.

string
nullable
country
required

Country code.

string
is_default
required

Whether this is the customer’s default address.

boolean
created_at
required

When the address was created, as an ISO 8601 timestamp.

string
updated_at
required

When the address was last updated, as an ISO 8601 timestamp.

string

Example generated

{
"id": 1,
"customer_id": 1,
"label": "example",
"recipient_name": "example",
"phone_number": "example",
"address_line1": "example",
"address_line2": "example",
"ward": "example",
"ward_name": "example",
"district": "example",
"city": "example",
"province": "example",
"province_name": "example",
"postal_code": "example",
"country": "example",
"is_default": true,
"created_at": "example",
"updated_at": "example"
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The resource does not exist in this store.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}