Sign in

v3

latestOpenAPI 3.1.0Proprietary (Listings API Terms of Service)2026-07-3156148214.6 KB
Locations

Fetch location info via cursor ids.

Returns full location information for a specified set of location IDs in one request.

get/api/v4/locations-by-ids

Query parameters

locationIdsstring required

JSON-encoded filter object

Response

Successful response

idstring required
databaseIdinteger
storeIdstring
namestring required
streetstring
citystring
stateIsostring
countryIsostring
postalCodestring
latitudenumber float
longitudenumber float
phonestring
websitestring
status'ACTIVE' | 'ARCHIVED' | 'PENDING' | 'TEMPORARILY_CLOSED' | 'SCHEDULED_FOR_ARCHIVE'

Lifecycle states of a location.

primaryGbpSiteCategoryIdstring
additionalGbpSiteCategoryIdsstring[]