Skip to main content
WEBHOOK
ParcelStatusChanged
{
  "action": "parcel_status_changed",
  "timestamp": 123,
  "carrier_status_change_timestamp": 123,
  "parcel": {
    "id": 1,
    "name": "Mr Bob",
    "company_name": "Sendcloud",
    "address": "Stadhuisplein 10",
    "address_divided": {
      "street": "Stadhuisplein",
      "house_number": 10
    },
    "city": "Eindhoven",
    "postal_code": "5611 EM",
    "telephone": "612345678",
    "email": "contact@sendcloud.com",
    "date_created": "2019-02-03T06:48:07",
    "tracking_number": "3SYZXG132912330",
    "weight": "2.000",
    "label": {
      "normal_printer": [
        "https://panel.sendcloud.sc/api/v2/label/normal_printer/3172?start_from=0&hash=bbfd669ee9ebb19408b85b33d181a50040fd9bc4"
      ],
      "label_printer": "https://panel.sendcloud.sc/api/v2/label/label_printer/3172?hash=bbfd669ee9ebb19408b85b33d181a50040fd9bc4"
    },
    "customs_declaration": {},
    "status": {
      "id": 1,
      "message": "Ready to send"
    },
    "data": {},
    "country": {
      "iso_3": "NLD",
      "iso_2": "NL",
      "name": "Netherlands"
    },
    "shipment": {
      "id": 1,
      "name": "PostNL Standard"
    },
    "order_number": "ORD12334",
    "shipment_uuid": "87e18823-016b-479b-b9e0-c5c0c4065452",
    "external_order_id": "AMZ23311",
    "external_shipment_id": "AMZ231231"
  }
}

Authorizations

​
Sendcloud-Signature
string
header
required

Body

application/json

Webhook data you will receive

The webhook payload when a parcel (either an outgoing or an incoming one) changes status.

​
action
enum<string>

Describes the webhook action

Available options:
parcel_status_changed
Example:

"parcel_status_changed"

​
timestamp
number

A unix timestamp indicating the time that the status changed

​
carrier_status_change_timestamp
number | null

A unix timestamp indicating the time that the status changed in the carrier's system

​
parcel
object

Parcel object

Response

200

Return a 200 status to indicate that the data was processed successfully. The response body may contain the extended line item.