Returns the list of Package objects

Returns the list of Package objects

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean

If active=true returns list of Packages that are active.

string

Expects an ISO8601 timestamp. Will only display Package objects that created at this exact time. Useful in conjunction with the "less than" and "greater than" filters to isolate a specific time range.

string

Expects an ISO8601 timestamp. Will only display Package objects that updated at this exact time. Useful in conjunction with the "less than" and "greater than" filters to isolate a specific time range.

string

Expects UUID sting. Will only display Package object with this UUID.

string

Expects tracking number. Will only display Package object with this tracking number.

integer

Expects id of OrderItem object. Will only display Package object that has that OrderItem object in its items.

integer

Expects id of Order object. Will only display Packages that are part of this Order.

fields
array of strings

Comma separated list of fields to display. Only the specified fields will be returned in the response body, along with fields related to those specified.

fields
string
enum
Allowed:
integer

Limit for results count

integer

Offset for returned results

Responses

301

Invalid request URL - make sure that the URL ends with a trailing slash.

401

Authentication error - make sure the API key & secret is valid, active and provided in the "API-AUTHENTICATION" header.

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