InventoryLocations
Get Many Locations
Get multiple locations with pagination and filtering
Authorization
api_key x-access-token<token>
In: header
Query Parameters
page?number
Page number for pagination (starting from 0)
Format
doubleDefault
0limit?number
Number of items per page
Format
doubleDefault
20search?string
Search term to filter locations by name
Default
""warehouse_id?string
Filter by warehouse IDs (comma-separated for multiple)
Default
""location_type_id?string
Filter by location type IDs (comma-separated for multiple)
Default
""location_kind?string
Filter by location kinds (comma-separated for multiple)
Default
""parent_location_id?string
Filter by parent location IDs (comma-separated for multiple)
Default
""is_hospital?boolean
Filter for hospital locations
pickable?boolean
Filter for pickable locations
sellable?boolean
Filter for sellable locations
order_by?string
Field to order results by
Default
"created_at"Value in
- "created_at"
- "updated_at"
- "name"
- "priority"
order?string
Order direction
Value in
- "asc"
- "desc"
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/shipos/locations"{ "data": [ { "barcode": "string", "team_id": "string", "parent_location_name": "string", "parent_location_id": "string", "warehouse_name": "string", "warehouse_id": "string", "location_type_name": "string", "location_type_id": "string", "location_kind": "STATIC", "on_hand": 0.1, "flagged_for_review": true, "is_empty": true, "is_hospital": true, "updated_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "priority": 0.1, "sellable": true, "pickable": true, "name": "string", "id": "string", "supported_actions": [ { "action": "VIEW_TOTE" } ] } ], "meta": { "page": 0.1, "page_size": 0.1, "has_next_page": true, "has_previous_page": true, "start_index": 0.1, "end_index": 0.1 }}