v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Locations

Search and filter stores, zones, tills, and concepts in your org by type, code, name, or external ID.

get/v2/locations

type'STORE' | 'ZONE' | 'TILL' | 'CONCEPT'

Filter by location type. Case-insensitive. Omit to return all types.

entityCodesstring

Comma-separated list of entity codes. Maximum 30 codes.

qstring

Prefix filter in field:value format. Valid fields: name, code, external_id. Values are case-sensitive. Comma-separate multiple filters.

isActiveboolean

Filter by active status. Omit to return both active and inactive.

isAdminboolean

Filter by admin access. Omit to return all.

isOrgUnitboolean

Filter concepts by org unit status. Only applies when type=CONCEPT.

limitinteger

Number of results per page. Between 1 and 100. Defaults to 20.

offsetinteger

Number of results to skip. Must be non-negative. Defaults to 0.

sortBy'entityCode' | 'name' | 'lastUpdated'

Field to sort results by. Defaults to lastUpdated.

sortOrder'ASC' | 'DESC'

Sort direction. Defaults to DESC.

includeCustomFieldsboolean

When true, includes custom field values in the response.

includeChildrenboolean

When true, returns child locations in hierarchy.children. Requires entityCodes to contain exactly one code.

childrenLimitinteger

Number of child results per page. Between 1 and 100. Defaults to 10. Only applies when includeChildren=true.

childrenOffsetinteger

Number of child results to skip. Must be non-negative. Defaults to 0. Only applies when includeChildren=true.

Locations retrieved successfully.

limitinteger

Page size used for this response.

offsetinteger

Pagination offset used for this response.

totalinteger

Total number of matching locations.