/
LI
listingsapi
/
Listings API
Search skmtc…
⌘K
Changes
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 12h ago · Updated 7d ago
Details
Filter operations
Analytics
3
Connected Accounts
15
Listings
6
Locations
13
get
Get locations by the Store Codes.
get
All locations that belong to an account.
post
Create a new location.
get
Search for locations.
get
Fetch location info via cursor ids.
post
Update information on a location.
post
Attach media files to a location as photos (stitched via schemastitcher).
post
Remove photos from a location.
post
Mark photos as favourite.
post
Archive locations.
post
Cancel archival of locations.
get
List media files attached to a single location (starred + unstarred).
get
Return the status of a bulk add-media-to-location request.
Posts
7
Reviews
10
Supporting APIs
4
Locations
Get locations by the Store Codes.
get
/api/v4/locations-by-store-codes
Query parameters
storeCodes
string
required
JSON-encoded filter object
Response
Successful response
LocationSummaryType[]
required
id
string
required
databaseId
integer
storeId
string
name
string
required
street
string
city
string
stateIso
string
countryIso
string
postalCode
string
latitude
number
float
longitude
number
float
phone
string
website
string
status
'ACTIVE'
|
'ARCHIVED'
|
'PENDING'
|
'TEMPORARILY_CLOSED'
|
'SCHEDULED_FOR_ARCHIVE'
Lifecycle states of a location.
primaryGbpSiteCategoryId
string
additionalGbpSiteCategoryIds
string[]
serviceArea
ServiceAreaType[]
tags
TagType[]
folders
FolderType[]
placeActionLinks
PlaceActionLinkType[]
discoveredPlaceActionLinks
PlaceActionLinkType[]
Changes