List Shipments
Since shipments power most of our services, we allow you to query and manage them. By querying shipments, you expose a paged service that allows you to use multiple filters.
Query Parameters | Description |
---|---|
batch_id | string, See warning below this table when filtering by batch_id |
tag | string |
shipment_status | pending , processing , label_purchased , cancelled |
modified_at_start | date string, (ISO 8601 Standard) 2019-07-25T15:24:46.657Z |
modified_at_end | date string, (ISO 8601 Standard) 2019-07-25T15:24:46.657Z |
created_at_start | date string, (ISO 8601 Standard) 2019-07-25T15:24:46.657Z |
created_at_end | date string, (ISO 8601 Standard) 2019-07-25T15:24:46.657Z |
page | integer, defaults to 1 |
page_size | integer, defaults to 25 |
sort_dir | asc or desc |
sort_by | modified_at , created_at |
Example
GET /v1/shipments
Let's get a list of the last package we sent using the east_warehouse
tag.