List manifests
Changed onSimilar to querying shipments, we allow you to query manifests since there will likely be a large number over a long period of time.
Request
- Base URL: https://api.shipengine.com
- URL: https://api.shipengine.com/v1/manifests
- Auth: API key in header API-Key
Query parameters
A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.
Warehouse ID
ship date start range
ship date end range
Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)
Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time)
A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.
Carrier ID
Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
The number of results to return per response.
Array of label ids
[ "se-28529731" ]
Response
The request was a success.
Example response
{
"manifests": [
{
"manifest_id": "se-28529731",
"form_id": "se-28529731",
"created_at": "2019-07-12T13:37:39.050Z",
"ship_date": "2019-07-12T13:37:39.050Z",
"shipments": 100,
"label_ids": [
"se-28529731"
],
"warehouse_id": "se-28529731",
"submission_id": "9475711899564878915476",
"carrier_id": "se-28529731",
"manifest_download": {
"href": "https://example.com/resource"
}
}
],
"total": 3,
"page": 3,
"pages": 4,
"links": {
"first": {
"href": "https://example.com/resource"
},
"last": {
"href": "https://example.com/resource"
},
"prev": {
"href": "https://example.com/resource"
},
"next": {
"href": "https://example.com/resource"
}
}
}Changes
- warning
added the new
bring_your_own_label_not_supportedenum value to the//response property for the response status - warning
added the new
bring_your_own_label_not_supportedenum value to the//response property for the response status - warning
added the new
bring_your_own_label_not_supportedenum value to the//response property for the response status - warning
added the new
multiple_sales_ordersenum value to the//response property for the response status - warning
added the new
multiple_sales_ordersenum value to the//response property for the response status - warning
added the new
multiple_sales_ordersenum value to the//response property for the response status - warning
added the new
sales_order_link_requiredenum value to the//response property for the response status - warning
added the new
sales_order_link_requiredenum value to the//response property for the response status - warning
added the new
sales_order_link_requiredenum value to the//response property for the response status
- warning
- breaking
the
/response's property type changed from no type toobjectfor status - breaking
the
/response's property type changed from no type toobjectfor status - breaking
the
/response's property type changed from no type toobjectfor status - breaking
the
////response's property type changed from no type tostringfor status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
removed from the
/response propertyallOflist for the response status - info
removed from the
/response propertyallOflist for the response status - info
removed from the
/response propertyallOflist for the response status - info
removed from the
////response propertyallOflist for the response status - info
the
////response's property pattern^se(-[a-z0-9]+)+$was added for the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status
- breaking