List shipments
Changed onGet list of Shipments
Request
- Base URL: https://api.shipengine.com
- URL: https://api.shipengine.com/v1/shipments
- Auth: API key in header API-Key
Query parameters
The possible shipment status values
A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.
Batch ID
Filter shipments by tag name. Returns only shipments that have been assigned the specified tag. You can filter by one tag at a time. Tags are arbitrary strings used to categorize shipments (e.g., "Priority", "Fragile", "International").
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)
Used to create a filter for when a resource was modified (ex. A shipment that was modified after a certain time)
Used to create a filter for when a resource was modified (ex. A shipment that was modified before a certain time)
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.
Sales Order ID
Controls the sort order of queries
| Value | Description |
|---|---|
| asc | Return results in ascending order |
| desc | Return results in descending order |
Controls the sort order of the query.
The possible shipments sort by values
Response
The request was a success.
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 - info
added the optional property
//////to the response with the status - info
added
subschema #2: shipment_sales_order_fieldsto the//response propertyallOflist 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 - breaking
the
///////response's property type changed from no type tostringfor status - breaking
the
////////response's property type changed from no type tostringfor status - breaking
the
/////response's property type changed from no type tostringfor status - breaking
the
//////////response's property type changed from no type tostringfor 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 toobjectfor status - breaking
the
////response's property type changed from no type tostringfor 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 - breaking
the
////////response's property type changed from no type tostringfor status - breaking
the
////////response's property type changed from no type tostringfor 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 - warning
added the new
amazon_caenum value to the////response property for the response status - warning
added the new
amazon_usenum value to the////response property for the response status - warning
added the new
anyenum value to the///////response property for the response status - warning
added the new
brightpearlenum value to the////response property for the response status - warning
added the new
cashenum value to the///////response property for the response status - warning
added the new
cash_equivalentenum value to the///////response property for the response status - warning
added the new
channel_advisorenum value to the////response property for the response status - warning
added the new
cratejoyenum value to the////response property for the response status - warning
added the new
ebayenum value to the////response property for the response status - warning
added the new
etsyenum value to the////response property for the response status - warning
added the new
gramenum value to the////////response property for the response status - warning
added the new
gramenum value to the//////////response property for the response status - warning
added the new
gramenum value to the//////response property for the response status - warning
added the new
groupon_goodsenum value to the////response property for the response status - warning
added the new
janeenum value to the////response property for the response status - warning
added the new
kilogramenum value to the////////response property for the response status - warning
added the new
kilogramenum value to the//////////response property for the response status - warning
added the new
kilogramenum value to the//////response property for the response status - warning
added the new
magentoenum value to the////response property for the response status - warning
added the new
noneenum value to the///////response property for the response status - warning
added the new
ounceenum value to the////////response property for the response status - warning
added the new
ounceenum value to the//////////response property for the response status - warning
added the new
ounceenum value to the//////response property for the response status - warning
added the new
paypalenum value to the////response property for the response status - warning
added the new
poundenum value to the////////response property for the response status - warning
added the new
poundenum value to the//////////response property for the response status - warning
added the new
poundenum value to the//////response property for the response status - warning
added the new
seller_activeenum value to the////response property for the response status - warning
added the new
shopifyenum value to the////response property for the response status - warning
added the new
squarespaceenum value to the////response property for the response status - warning
added the new
stitch_labsenum value to the////response property for the response status - warning
added the new
three_dcartenum value to the////response property for the response status - warning
added the new
tophatterenum value to the////response property for the response status - warning
added the new
volusionenum value to the////response property for the response status - warning
added the new
walmartenum value to the////response property for the response status - warning
added the new
woo_commerceenum value to the////response property for the response 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
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
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
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
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
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
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
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
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 - 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