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

idsstring required

URL-encoded JSON array of base64 location IDs, e.g. ids=%5B%22TG9jYXRpb246MTgwMzk0NA%3D%3D%22%5D

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