Skip to content

Locations

GET /locations

List locations (stores and warehouses).

Request

GET /api/{account}/v4.0.0/locations
Authorization: Bearer <xa-token>

Parameters

Name In Type Required Description
nonce query integer (int64) No Client-generated unique sequential number
searchString query string No Search by location code or description
searchColumn query string No Column to search
searchOperator query string No Comparison operator: lt, lte, gt, gte, ne
skip query integer No Number of records to skip (pagination)
limit query integer No Max records to return. Max: 1000, default: 50

Responses

200 — Success

Returns an array of location objects (empty array if none found).

400 — Invalid input parameters


See Also