Skip to navigation
Location Management

List Locations

View as Markdown

Returns the locations for your brand, along with counts of how many locations are in each status.

Endpoint

GET {{domain}}/{{tenant_id}}/locations

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

Query Parameters

ParameterTypeDescription
pageIntegerThe page of results to return. Defaults to 1.
per_pageIntegerThe number of locations per page. Defaults to 10.
searchStringOptional. A text filter to narrow the results.

Response

A successful request returns 200 OK.

200 OK
{
    "data": [ { } ],
    "total": 12,
    "active": 8,
    "pending": 3,
    "disabled": 1
}
FieldTypeDescription
dataArrayThe locations on the requested page.
totalNumberThe total number of locations.
activeNumberThe number of locations that are active.
pendingNumberThe number of locations that are pending.
disabledNumberThe number of locations that are disabled.

The count fields cover all of your locations, not just the current page.

Location statuses

StatusMeaning
ActiveThe location is live and available for delivery allocation.
PendingThe location is awaiting activation by Rendr.
DisabledThe location is inactive and not used for deliveries.

See Create a Location for how locations move from pending to active.