Skip to main content
PATCH
/
v1
/
shipments
/
{id}
Update
curl --request PATCH \
  --url https://{defaultHost}/v1/shipments/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "shipment": {
    "label_file_type": "PNG"
  }
}
'
{
  "id": "b345e53e-5f77-4e78-b556-a572bbe96f25",
  "object": "shipment",
  "status": "draft",
  "live_mode": true,
  "label_url": null,
  "label_file_type": "PNG",
  "tracking_number": null,
  "tracking_url": null,
  "tracking_status": null,
  "eta": null,
  "weight": null,
  "weight_unit": "lb",
  "carrier": null,
  "dimensions": null,
  "rates": [],
  "selected_rate": null,
  "fulfillment": "af6c225d-6f27-4971-9fce-172afa64f8dd",
  "shipping_provider": "60e347c4-6482-4ac5-82fb-1a98ca0a8162",
  "from_address": null,
  "to_address": null,
  "parcel_template": null,
  "created_at": 1773748364,
  "updated_at": 1773748364
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json
​
shipment
object

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
label_file_type
string

The file type for the shipping label – one of PDF, PDF_A4, PDF_A6, PDF_4x6, PDF_4x8, PNG, ZPLII.

​
parcel_template
string

Expandable – The associated parcel template ID.

​
weight
string | null

The weight of the parcel.

​
weight_unit
string | null

The unit of the weight.

​
inherit_weight
boolean

When true, inherit the weight from the fulfillment.

​
dimensions
object

The dimensions of the parcel.

​
status
string

The current status of this shipment – one of draft, quoted, purchased, voided.

​
live_mode
boolean

Whether or not this shipment was created in live mode.

​
label_url
string | null

The URL for the purchased shipping label.

​
tracking_number
string | null

The tracking number for this shipment.

​
tracking_url
string | null

The URL to track this shipment.

​
carrier
string | null

The shipping carrier for this shipment.

​
tracking_status
string | null

The current tracking status – one of unknown, pre_transit, in_transit, delivered, returned, failure.

​
eta
string | null

The estimated time of arrival.

​
rates
object[]

The available shipping rates for this shipment.

​
selected_rate
object

The selected shipping rate for this shipment.

​
fulfillment

Expandable – The associated fulfillment ID.

​
shipping_provider

Expandable – The associated shipping provider ID.

​
from_address

Expandable – The associated address ID.

​
to_address

Expandable – The associated address ID.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.