Skip to main content
List shipments

Authorizations

X-API-Key
string
header
required

Query Parameters

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

Response

200 - application/json
id
string<uuid>
required
bigcommerce_id
integer
required
created_at
string<date-time>
required
order_id
string<uuid>
required
carrier
enum<string>
required
  • stamps_com - Stamps.com
  • usps - USPS
  • fedex - FedEx
  • ups - UPS
  • canada_post - Canada Post
  • australia_post - Australia Post
  • other - Other
Available options:
stamps_com,
usps,
fedex,
ups,
canada_post,
australia_post,
other
tracking_number
string
required
Minimum string length: 1
tracking_url
string<uri>
required
Minimum string length: 1
ship_date
string<date>
required
notes
string
required
read-only
from_address
object | null
required
to_address
object
required
items
object[]
required
custom_fields
object[]
required