Skip to navigation
API ReferenceBrowseLocations

List locations

Returns active markets the authenticated retailer has access to, ordered by name ascending.

Authentication

X-TT-API-Keystring
API Key authentication via header

Headers

X-TT-RetailerstringRequired
Your retailer identifier, provided during onboarding. It must be a retailer your API key was issued for.
X-TT-PlatformenumRequired
Identifies the platform the request comes from.
Allowed values:

Query parameters

limitintegerOptional1-1000Defaults to 50
Maximum number of results to return.
offsetintegerOptional>=0Defaults to 0
Number of results to skip for pagination.

Response headers

X-RateLimit-Limitinteger
How many requests this API key may make for this retailer in the current window. Sent only when the request was counted against that limit. A response served from cache was not counted and repeats the value it was cached with.
X-RateLimit-Remaininginteger
How many requests this API key has left for this retailer in the current window. Sent only when the request was counted against that limit. A response served from cache was not counted and repeats the value it was cached with.

Response

Paginated list of locations.
datalist of objectsOptional
List of entities in the current page.
paginationobjectOptional
Pagination metadata.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error