BlogContact Us
API Reference

List Shipments

get
https://api.tive.com/public/v3/Shipments

List all shipments within the specified account.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
States
array of strings

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

States
date-time

Returns all shipments started or completed after the specified UTC dateTime.

date-time

Returns all shipments started or completed before the specified UTC dateTime.

ShipmentIds
array of strings

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

ShipmentIds
int32

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

int32

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

Headers
int32
required

ID of the account the request will be made in.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

The requested shipment is not available

401

Unauthorized

500

Internal Server Error

Updated 7 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 7 months ago