Retrieve a location
Retrieve a location
Authorizations:Token, JWT
Query Parameters
| id required | integer>= 1 |
Responses
200Location resource
Response schema:
Location resource | name | string[1 .. 255] charactersExample: "Sale" |
| type | string[1 .. 32] charactersEnum: "warehouse""company_address""internal_warehouse""pickup_point"Example: "warehouse" |
| locationCode | string[1 .. 32] charactersExample: "NY10001" |
| phoneNumber | string<= 64 charactersExample: "555-867-5309" |
string<= 255 charactersExample: "warehouse@example.com" | |
| staffNotes | string<= 255 charactersExample: "Please use the back entrance for all deliveries." |
| id | integer or null>= 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 |
404Resource not found
Response schema:
Resource not found | 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 |