v1

latestOpenAPI 3.0.12026-07-2487135176.5 KB
Shipments

List Shipments

List all shipments within the specified account.

get/public/v3/Shipments

Query parameters

Statesstring[]

Allows filtering of results by one or more of the following shipment states: Upcoming, Active, or Completed.

Startstring date-time

Returns all shipments <emp>started or completed</emp> after the specified <a href="https://developers.tive.com/docs/timestamps">UTC</a> dateTime.

Endstring date-time

Returns all shipments <emp>started or completed</emp> before the specified <a href="https://developers.tive.com/docs/timestamps">UTC</a> dateTime.

ShipmentIdsstring[]

string

Allows filtering of results by one or more comma separated shipmentIds.

PageSizeinteger

The number of results to retrieve. Default and maximum is 50.

PageNumberinteger

The page number to use. This is needed when there are more objects than the max page size. The default is 1.

Headers

x-tive-account-idinteger required

ID of the account the request will be made in.

Response

The requested shipments

totalRecordsinteger
pageNumberinteger
pageSizeinteger
nextstring nullable
previousstring nullable