GET v1/shipments

shipengine.com

Summary: List Shipments
Operation ID: list_shipments
Auth: unknown
Description

Get list of Shipments

Parameters (12)

batch_id (?, query, optional)

Batch ID

created_at_end (string, query, optional)

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

created_at_start (string, query, optional)

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

modified_at_end (string, query, optional)

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

modified_at_start (string, query, optional)

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

page (integer, query, optional, default: 1)

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.

Constraints: {'minimum': 1}

page_size (integer, query, optional, default: 25)

The number of results to return per response.

Constraints: {'minimum': 1}

sales_order_id (string, query, optional)

Sales Order ID

shipment_status (?, query, optional)
sort_by (?, query, optional)
sort_dir (?, query, optional, default: desc)

Controls the sort order of the query.

tag (string, query, optional)

Search for shipments based on the custom tag added to the shipment object

Constraints: {'minLength': 1}

No probe data for this endpoint yet.