Sign in
shipments

List shipments

Get list of Shipments

get/v1/shipments

Query parameters

shipment_status'pending' | 'processing' | 'label_purchased' | 'cancelled'

The possible shipment status values

batch_idstring

A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.

Example:se-28529731

Batch ID

tagstring

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").

created_at_startstring date-time

Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)

created_at_endstring date-time

Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time)

modified_at_startstring date-time

Used to create a filter for when a resource was modified (ex. A shipment that was modified after a certain time)

modified_at_endstring date-time

Used to create a filter for when a resource was modified (ex. A shipment that was modified before a certain time)

pageinteger

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.

page_sizeinteger

The number of results to return per response.

sales_order_idstring

Sales Order ID

sort_dir'asc' | 'desc'

Controls the sort order of queries

ValueDescription
ascReturn results in ascending order
descReturn results in descending order

Controls the sort order of the query.

sort_by'modified_at' | 'created_at'

The possible shipments sort by values

Response

The request was a success.

totalinteger required

Total number of shipments returned by the api call

pageinteger required
pagesinteger required

Changes