GET
List shipments

Authorizations

Authorization
string
header
required

sk_test_ / sk_live_ / rk_test_ / rk_live_ keys

Headers

Shipping-Version
string
Shipping-Account
string

Act on behalf of a connected account (acct_...)

Query Parameters

limit
integer
default:10
Required range: 1 <= x <= 100
starting_after
string
ending_before
string
expand[]
string[]
status
enum<string>
Available options:
draft,
purchasing,
purchase_failed,
purchased,
manifested,
void_pending,
voided,
void_failed
tracking.status
enum<string>
Available options:
pre_transit,
in_transit,
out_for_delivery,
available_for_pickup,
delivered,
exception,
return_to_sender,
returned,
cancelled,
unknown
carrier
string
connection
string
purchase.service.code
string
tracking.number
string
reference
string
order.id
string
returns.is_return
boolean
handover.manifest
string

ID or none

handover.pickup
string

ID or none

handover.close_group
string
ship_date[gte]
string<date>
ship_date[lte]
string<date>
created[gte]
integer
created[lte]
integer

Response

OK

object
enum<string>
required
Available options:
list
has_more
boolean
required
data
object[]
required
url
string