Skip to navigation

Get a Location

View as Markdown

Returns a single location.


Endpoint

GET {{domain}}/{{tenant_id}}/location

Authentication: Bearer token required via the Authorization header. The caller needs the ViewStore permission.

The path is singular (/location), and there is no ID parameter. The tenant_id in the path identifies the store, and is the store’s own tenant ID — for example brand-store.


Response

A successful request returns 200 OK with the location.

200 OK
{
"data": { }
}
FieldTypeDescription
dataObjectThe location.

The fields returned depend on the caller’s field-scope permission.