v1
latestOpenAPI 3.0.02026-07-1397337495.2 KBList Shipments
Get list of Shipments
Query parameters
The possible shipment status values
A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.
Batch ID
Search for shipments based on the custom tag added to the shipment object
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.