InventoryTotes
Get Many Totes
Get multiple totes 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 totes by name
Default
""warehouse_id?string
Filter by warehouse IDs (comma-separated for multiple)
Default
""barcode?string
Filter by barcode
Default
""has_orders?boolean
Filter totes by whether they have orders
empty?boolean
Filter for empty totes
order_by?string
Field to order results by
Default
"created_at"Value in
- "created_at"
- "updated_at"
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/totes"{ "data": [ { "on_hand": 0.1, "is_empty": true, "barcode": "string", "updated_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "location_type_id": "string", "parent_location_name": "string", "parent_location_id": "string", "location_kind": "STATIC", "warehouse_id": "string", "name": "string", "team_id": "string", "id": "string", "parent_location": { "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" }, "picking_session_fulfillment_orders": [ { "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "status": "PENDING", "fulfillment_order_id": "string", "tote_id": "string", "tote_name": "string", "picking_session_id": "string", "order_number": "string", "packing_started_at": "2019-08-24T14:15:22Z", "packing_completed_at": "2019-08-24T14:15:22Z", "packed_by_user_id": "string", "packed_by_user_name": "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 }}