Skip to content

shipment.status_changed

POST

AWB status changed (shipment.status_changed). Sent to an installation granted read_shipments.

webhook-id
required
string
/^msg_[0-9a-z]{26}$/

The message id, the same on every attempt: deduplicate on it.

webhook-timestamp
required
integer

Seconds since the epoch at this attempt; refuse one too far from now.

webhook-signature
required
string

v1, + base64 HMAC-SHA256 of {webhook-id}.{webhook-timestamp}.{body} with the signing secret (Standard Webhooks).

Media typeapplication/json
object
type
required

The webhook type.

string
Allowed value: shipment.status_changed
timestamp
required

When the event happened, UTC with six fractional digits (2026-11-13T09:30:00.123456Z).

string format: date-time
organization
required

The organization it happened in (org_...).

string
/^org_[0-9a-z]{26}$/
data
required
ShipmentResource
object
id
required

The shipment’s public id (shp_...).

string
/^shp_[0-9a-z]{26}$/
order_id
required

The order it ships (ord_...); null once the order was deleted.

string | null
/^ord_[0-9a-z]{26}$/
direction
required

Outbound (to the buyer) or return (back to the merchant). New values may appear: treat one you do not know as such.

string
status
required

Pending, failed, needs_attention, created, picked_up, in_transit, customs_hold, out_for_delivery, awaiting_pickup, delivery_issue, delivered, returning, returned, cancelled, lost. New values may appear: treat one you do not know as such.

string
vendor
required

The vendor code of the integration the AWB was made through (woot, sameday, fancourier, …); kept when the account is removed.

string
integration_id
required

The courier account (an installed integration, int_...); null once it was removed.

string | null
/^int_[0-9a-z]{26}$/
carrier
required

Who physically transports the parcel (dpd, sameday, fancourier, …); null until known.

string | null
service_code
required

The courier’s service code the AWB was asked with.

string | null
awb
required

The carrier’s tracking number; null until the courier issues it. Not unique across couriers.

string | null
label_available
required

Whether the label can be printed in the app now; the label file is not served by API v1.

boolean
error_code
required

Why it is failed or needs_attention, a stable code: account_unavailable, not_supported, credentials_rejected, rate_limited, invalid_data, vendor_rejected, not_sent, outcome_unknown. Null in any other status. New codes may appear. New values may appear: treat one you do not know as such.

string | null
error_message
required

The code’s meaning, in English; the app shows the merchant the full reason in their language.

string | null
vendor_message
required

The courier’s own words when it answered (vendor_rejected), as it sent them, in its language: for display only, never to parse.

string | null
delivery_method
required

Address (the recipient’s door) or pickup_point (a locker, office or partner point); an order’s delivery.method in the same codes. New values may appear: treat one you do not know as such.

string
pickup_point
required

The point it is delivered to, for a pickup_point delivery; null otherwise.

object
external_id
required

The point’s id in the courier’s ids.

string | null
total_weight_kg
required
string | null
parcels
required

Every parcel of the shipment, in order (as many as the courier was asked for).

Array<object>
object
kind
required

Parcel, envelope or pallet. New values may appear: treat one you do not know as such.

string
weight_kg
required
string | null
length_cm
required
string | null
width_cm
required
string | null
height_cm
required
string | null
tracking_number
required

The parcel’s own tracking number, where the courier issues one per parcel.

string | null
cod
required

Cash on delivery the courier collects from the recipient; null without.

object
amount
required
string
currency
required
string
declared_value
required

The declared (insured) value; null when none was declared.

object
amount
required
string
currency
required
string
sender
required

The v1 address shape (first_name, last_name, locality_code and the like null where the AWB holds none) plus the person to ask for at a company.

object
name
required
string | null
first_name
required
string | null
last_name
required
string | null
company
required
string | null
email
required
string | null
phone
required
string | null
address_line_1
required
string | null
address_line_2
required
string | null
city
required
string | null
region
required
string | null
region_code
required
string | null
postal_code
required
string | null
country_code
required
string | null
locality_code
required
string | null
contact_person
required
string | null
recipient
required
object
name
required
string | null
first_name
required
string | null
last_name
required
string | null
company
required
string | null
email
required
string | null
phone
required
string | null
address_line_1
required
string | null
address_line_2
required
string | null
city
required
string | null
region
required
string | null
region_code
required
string | null
postal_code
required
string | null
country_code
required
string | null
locality_code
required
string | null
contact_person
required
string | null
cancellation
required

Carrier: cancelled at the courier (asked by the platform, or reported by its tracking); local: cancelled in the platform only (a courier without a cancel API, or a shipment set aside without an AWB).

object
kind
required

New values may appear: treat one you do not know as such.

string
cancelled_at
required
string | null format: date-time
tracking_events
required

The courier’s latest tracking events, at most 20, newest last.

Array<object>
object
status
required

The same codes as status; null when the courier’s own status maps to none. New values may appear: treat one you do not know as such.

string | null
description
required

The event as the courier worded it, untranslated.

string | null
location
required

Where it happened, as the courier reported it.

string | null
occurred_at
required
string format: date-time
picked_up_at
required
string | null format: date-time
delivered_at
required
string | null format: date-time
returned_at
required
string | null format: date-time
created_at
required

When the AWB was asked for.

string format: date-time
updated_at
required
string format: date-time

Gone: no more webhooks are sent to this URL until its partner turns them back on.

Received. Any other answer is retried on the schedule.