Skip to content

List inventory locations

GET
/stores/{storeRef}/inventory/locations
curl --request GET \
--url https://apibase.ecomweb.app/api/v1/stores/example/inventory/locations \
--header 'x-api-key: <x-api-key>'

Returns the locations that hold the store’s stock, default location first. A store has one location for now.

Required scopes: read:inventory

storeRef
required
string

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

Media typeapplication/json
object
data
required

The locations, default first.

Array<object>
object
id
required

Location ID.

number
name
required

Location name.

string
is_default
required

Whether this is the store’s default location.

boolean

Example generated

{
"data": [
{
"id": 1,
"name": "example",
"is_default": true
}
]
}

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"
}