FulfillmentCartons
Get Many Cartons
Get multiple cartons 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 cartons by name
Default
""name?string
Filter by carton name
Default
""width?number
Filter by carton width
Format
doubleDefault
nullheight?number
Filter by carton height
Format
doubleDefault
nulllength?number
Filter by carton length
Format
doubleDefault
nullis_default?boolean
Filter for default cartons
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/cartons"{ "data": [ { "updated_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "team_id": "string", "default": true, "weight": 0.1, "weight_unit": "G", "height": 0.1, "width": 0.1, "length": 0.1, "measurement_unit": "MM", "name": "string", "id": "string", "supported_actions": [ { "action": "UPDATE_CARTON" } ] } ], "meta": { "page": 0.1, "page_size": 0.1, "has_next_page": true, "has_previous_page": true, "start_index": 0.1, "end_index": 0.1 }}