Skip to main content
GET
Get a shipment

Authorizations

Authorization
string
header
required

Your API key, sent as a bearer token. Keep it on your server. See Authentication. A request from a location we refuse gets a 403 with Access denied, whether or not it has a valid key: where you can call from.

Path Parameters

id
string<uuid>
required

The id Create a shipment returned, or the shipment_id in an error.

Response

The shipment.

A shipment as a webhook sends it. It has nothing from the customer's address.

id
string
required

The shipment's id. Get a shipment takes it.

status
enum<string>
required
  • pending: the shipment hasn't reached an order yet.
  • needs_review: we couldn't confirm the charge, and it's with our team.
  • processing: the order is queued for fulfillment.
  • shipped, delivered: the carrier has it, or has delivered it.
  • cancelled: the order was cancelled or resolved outside shipping.
Available options:
pending,
needs_review,
processing,
shipped,
delivered,
cancelled
card_ids
string[]
required
carrier
string | null
required

null until we've confirmed a rate.

service
string | null
required
service_token
string | null
required
cost
number | null
required

What the shipment charges in USD, including any insurance premium. null until we've confirmed a rate.

cover_amount
number | null
required

The insurance on this shipment, in USD. null without insurance, and before the order exists.

insurance_cost
number | null
required

The premium in USD, which is part of cost. 0 without insurance, and null before the order exists.

tracking_number
string | null
required

null until there's a label.

tracking_url
string | null
required
created_at
string
required
status_updated_at
string | null
required

When the order's status last changed.

shipped_at
string | null
required
expected_delivery
string | null
required
delivered_at
string | null
required
destination_country
string
required
items
object[]
required

The cards in the shipment. Empty until the order exists.

address
object | null
required

Where it ships to. null until the order exists, and after we've removed the address.

needs_review
boolean

Present and true while status is needs_review.

address_removed
boolean

Present and true once we've removed the address.