v3

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

Get locations by the Store Codes.

Returns full location details for one or more locations identified by their store codes.

get/api/v4/locations-by-store-codes

Query parameters

storeCodesstring required

JSON-encoded filter object

JSON-encoded array of store code strings, e.g. ["ACME01","jio678"]. URL-encode the value.

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[]