v8

latestOpenAPI 3.0.02026-08-088001,2863.3 MB
commerce
location

List all locations

get/commerce/{connection_id}/location

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

org_idstring

The org ID to filter by (reference to AccountingOrganization)

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time
updated_atstring date-time
namestring
descriptionstring
is_activeboolean
language_localestring
parent_idstring
currencystring
location_type'RESTAURANT' | 'SALON' | 'WAREHOUSE' | 'STORE' | 'OTHER'
ratingnumber
review_countnumber
price_levelstring
latitudenumber
longitudenumber
image_urlstring
web_urlstring
rawobject
categoriesstring[]