shipping.label_purchased

A shipping label was successfully purchased for an order and is ready to use. Subscribe to this event to drive fulfillment steps such as notifying the customer, advancing the order's status, or recording the shipment's tracking reference. The event's `data.object` contains the public shipping resource; see this event's payload schema and example for the exact fields.

stablev1shippingscope: shipping:read

Payload

Webhook deliveries use the common event envelope. The event-specific object is available at data.object.

events/public/payloads/shipping.label_purchased.v1.schema.jsonevents/public/examples/shipping.label_purchased.v1.json

data.object fields

Field	Type	Required
`id`	`string \| null`	optional
`object`	`string \| null`	optional
`metadata`	`object \| null`	optional

dynamic data.object fields

Loading documentation...

Example

Event body

{
  "api_version": "2026-06-09",
  "created": "2026-06-09T12:00:00Z",
  "data": {
    "object": {
      "event": "shipping.label_purchased",
      "id": "ship_example",
      "metadata": {
        "example": true
      },
      "object": "shipping"
    }
  },
  "environment": "test",
  "id": "wevt_Abcdef1234567890Ghijk",
  "livemode": false,
  "object": "event",
  "type": "shipping.label_purchased"
}

data.object

{
  "event": "shipping.label_purchased",
  "id": "ship_example",
  "metadata": {
    "example": true
  },
  "object": "shipping"
}

`(_id\|^id)$`	`string \| null`	optional
`.*_at$`	`string \| null`	optional	format: date-time