List Shipments

get

https://api.warehance.com/v1/shipments

Required permission: read_shipments

Get a list of shipments for your organization or client.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

sort_by

string

enum

Specifies the field by which to sort the returned shipments:

created_at: Sort by the creation date of the shipment.
shipment_cost: Sort by the cost of the shipment. This is only available for organization API keys.

Allowed:

created_at_date_start

date-time

The start date-time for filtering shipments created after this date.

created_at_date_end

date-time

The end date-time for filtering shipments created before this date.

voided_at_date_start

date-time

The start date-time for filtering shipments voided after this date.

voided_at_date_end

date-time

The end date-time for filtering shipments voided before this date.

limit

integer

1 to 100

Defaults to 25

The maximum number of items to return in the response. Used for pagination. Must be between 1 and 100.

cursor

string

A cursor for pagination. Use the next_cursor value from a previous response to fetch the next page of results. This provides more efficient pagination than offset-based pagination, especially for large datasets. Cannot be used together with the offset parameter.

order_by

string

enum

Defaults to asc

Specifies the sort direction of the returned items:

asc: Ascending order. For dates, this means from oldest to newest. For numbers, this means from smallest to largest.
desc: Descending order. For dates, this means from newest to oldest. For numbers, this means from largest to smallest.

Allowed:

search_value

string

A value to search for within the items. The specific fields searched depend on the endpoint.

client_id

integer

≥ 1

Only applicable for organizations. Filters items by the specified client_id, provided the client_id belongs to the organization. Note: API keys can belong to either client level or organization level.

order_id

integer

Filter shipments by order ID. Returns all shipments associated with the specified order.

shipment_ids

string

A comma-separated list of shipment IDs to filter by. Maximum of 100 IDs.
Example: 123,456,789

updated_at_start

date-time

Filters items by the specified updated_at start date.

updated_at_end

date-time

Filters items by the specified updated_at end date.

latest_tracking_event_at_start

date-time

The start date-time for filtering shipments whose latest tracking event occurred after this date.

latest_tracking_event_at_end

date-time

The end date-time for filtering shipments whose latest tracking event occurred before this date.

Responses

200A list of shipments

400Example Error Response