Skip to main content

Retrieve a list of locations

Retrieve a list of locations

Authorizations:Token, JWT
Query Parameters
pageintegerDefault: 1The collection page number
itemsPerPageinteger[0 .. 100]Default: 30The number of items per page
paginationbooleanEnable or disable pagination

Responses

200Location collection
Response schema:
Location collection
Array
namestring[1 .. 255] characters
typestring[1 .. 32] charactersEnum: "warehouse""company_address""internal_warehouse""pickup_point"
locationCodestring[1 .. 32] characters
phoneNumberstring<= 64 characters
emailstring<= 255 characters
staffNotesstring<= 255 characters
idinteger>= 1
401Unauthorized
Response schema:
Unauthorized
typestringExample: "https://tools.ietf.org/html/rfc2616#section-10"
titlestringExample: "An error occurred"
detailstring or nullExample: "Cannot find entity"
instancestring or null
500Internal error
Response schema:
Internal error
typestringExample: "https://tools.ietf.org/html/rfc2616#section-10"
titlestringExample: "An error occurred"
detailstring or nullExample: "Cannot find entity"
instancestring or null