Retrieve a list of locations
Retrieve a list of locations
Authorizations:Token, JWT
Query Parameters
page | integerDefault: 1 The collection page number |
itemsPerPage | integer[0 .. 100]Default: 30 The number of items per page |
pagination | booleanEnable or disable pagination |
Responses
200Location collection
Response schema:
Location collection Array
name | string[1 .. 255] characters |
type | string[1 .. 32] charactersEnum: "warehouse" "company_address" "internal_warehouse" "pickup_point" |
locationCode | string[1 .. 32] characters |
phoneNumber | string<= 64 characters |
string<= 255 characters | |
staffNotes | string<= 255 characters |
id | integer>= 1 |
401Unauthorized
Response schema:
Unauthorized type | stringExample: "https://tools.ietf.org/html/rfc2616#section-10" |
title | stringExample: "An error occurred" |
detail | string or nullExample: "Cannot find entity" |
instance | string or null |
500Internal error
Response schema:
Internal error type | stringExample: "https://tools.ietf.org/html/rfc2616#section-10" |
title | stringExample: "An error occurred" |
detail | string or nullExample: "Cannot find entity" |
instance | string or null |