Events & Payloads

This page lists every event type you can subscribe to, when it is sent, and the data it carries.

Request Body

Every event is sent as a POST request with the same envelope: the event type, its timestamp, its sequence and the event data, in message.

{
  "event": "order.packed",
  "timestamp": "2026-10-08T12:55:24.206Z",
  "sequence": 128734512,
  "message": {
    "orderId": "…",
    "fulfillmentOrderIds": ["…"],
    "fulfillmentOrderId": "…",
    "eventDate": "2026-10-08T12:55:24.195Z"
  }
}

Field	Type	Description
event	string	The event type, one of the available events.
timestamp	string	ISO 8601 date of the change that produced the event.
sequence	integer	Ordering and deduplication key, see below.
message	object	The event data. Its shape depends on the event type, detailed on this page.

Ordering and duplicates

Events may arrive out of order, and the same event may be delivered more than once.

• Use sequence to order the events of an order or a parcel: a larger sequence is a more recent state. Do not rely on timestamp for this: two changes made at the same time can carry timestamps in the reverse order of the states they describe.
• Use sequence to detect a duplicate: it is unique per event and does not change when an event is delivered again.

Reading a payload

• Identifiers are named after what they designate: orderId, parcelId, fulfillmentOrderId… A payload never carries a bare id.
• Most payloads describe the current state, not the change: store them as they are, replacing what you held. The lifecycle events are the exception: they describe a step that happened, with its date.
• Enumerated values travel as strings (status, service…), and new values may appear. Do not reject an event because of a value you do not know.
• Dates are ISO 8601 strings.
• New fields may be added to a payload at any time. Ignore the fields you do not use.

Available Events

Orders

Event type	When it is sent	Payload
order.created	An order is created	The order, its recipient and its sales channel
order.updated	An order changes (anything but creation and cancel)	The order
order.cancelled	An order is cancelled	The order
order.recipientUpdated	The recipient of an order changes	The recipient
order.collectsUpdated	The collects an order belongs to change	The full list of the order's collects
order.fulfillmentOrderUpdated	One of the fulfillment orders of an order changes	The fulfillment order
order.packed	An order (or one of its fulfillment orders) is packed	The lifecycle step and its date
order.shipped	An order is shipped	The lifecycle step and its date
order.dispatched	An order is dispatched	The lifecycle step and its date
order.received	An order is received	The lifecycle step and its date
order.putInCollect	An order is put in a collect	The lifecycle step and its date
order.delivered	An order is delivered	The lifecycle step and its date

Parcels

Event type	When it is sent	Payload
parcel.created	A parcel is created	The parcel
parcel.updated	The status of a parcel advances	The parcel
parcel.cancelled	A parcel is cancelled	The parcel

Order Events

Every order payload starts with the order anchor: orderId and fulfillmentOrderIds.

order.created

Sent once, when an order is created. It carries everything the creation establishes: the order, its recipient and the sales channel it came from.

Field	Type	Description
…	Order anchor	orderId, fulfillmentOrderIds
…	Order fields	ref, status, service…
recipient	Recipient	The recipient of the order
channelOrder	Sales channel | null	The sales channel the order came from, null for a manual order

{
  "orderId": "…",
  "fulfillmentOrderIds": ["…"],
  "ref": "CMD-10452",
  "status": "CREATED",
  "progress": "OPENED",
  "service": "…",
  "organizationService": "…",
  "organizationId": "…",
  "tags": [],
  "isSignatureEnabled": false,
  "isSaturdayDeliveryEnabled": false,
  "isInsuranceEnabled": false,
  "isExternalOrder": false,
  "carrierPickupId": null,
  "carrierPickupName": null,
  "invoiceUrl": null,
  "customLocation": null,
  "warehouseAnomalyToProcessStatus": "…",
  "cachedWingWarehouseId": "…",
  "cachedOrganizationExpeditorId": "…",
  "createdAt": "2026-10-08T12:55:24.195Z",
  "orderedAt": "2026-10-08T12:50:00.000Z",
  "recipient": {
    "cmsId": null,
    "fullName": "Jane Doe",
    "firstName": "Jane",
    "lastName": "Doe",
    "company": null,
    "phone": "+33600000000",
    "email": "jane.doe@example.com",
    "line1": "1 rue de Rivoli",
    "line2": null,
    "additional": null,
    "city": "Paris",
    "zip": "75001",
    "countryCode": "FR",
    "anonymizedAt": null
  },
  "channelOrder": null
}

order.updated

Sent when any of the order fields changes, except at creation and cancellation. The payload always carries all the order fields, not only the changed ones: replace the order you hold with it.

Field	Type	Description
…	Order anchor	orderId, fulfillmentOrderIds
…	Order fields	Every field of the order

order.cancelled

Sent when an order is cancelled. Same payload as order.updated, with the order's status after the cancellation.

order.recipientUpdated

Sent when the recipient of an order changes. The payload carries the recipient as it is now.

Field	Type	Description
…	Order anchor	orderId, fulfillmentOrderIds
recipient	Recipient	The current recipient

order.collectsUpdated

Sent when the collects an order belongs to change: the order is added to a collect or removed from one.

Field	Type	Description
…	Order anchor	orderId, fulfillmentOrderIds
collects	Collect[]	Every collect the order belongs to

Replace the list

collects is the complete list. A collect missing from it means the order no longer belongs to it: replace the list you hold, do not merge it entry by entry. The same event may also arrive with a list identical to the previous one.

{
  "orderId": "…",
  "fulfillmentOrderIds": ["…"],
  "collects": [
    {
      "collectId": "…",
      "status": "INITIATED",
      "organizationPickupId": "…",
      "shouldStartAt": "2026-10-09T08:00:00.000Z",
      "shouldEndAt": "2026-10-09T12:00:00.000Z"
    }
  ]
}

order.fulfillmentOrderUpdated

Sent when one of the fulfillment orders of an order is created, changes, or is deleted. A deleted fulfillment order is not removed: its status says so.

Field	Type	Description
…	Order anchor	orderId, fulfillmentOrderIds
fulfillmentOrderId	string	The fulfillment order this event is about
…	Fulfillment order fields	Every field of that fulfillment order

Which fulfillment order?

fulfillmentOrderIds lists every fulfillment order of the order. The one this event is about is fulfillmentOrderId.

Lifecycle events

order.packed, order.shipped, order.dispatched, order.received, order.putInCollect and order.delivered each mark a step of the order's lifecycle. They share the same payload: the step, its date, and the fulfillment order it concerns.

Field	Type	Description
…	Order anchor	orderId, fulfillmentOrderIds
fulfillmentOrderId	string | null	The fulfillment order the step concerns, or null when it concerns the whole order
eventDate	string	ISO 8601 date of the step

{
  "orderId": "…",
  "fulfillmentOrderIds": ["…", "…"],
  "fulfillmentOrderId": "…",
  "eventDate": "2026-10-08T12:55:24.195Z"
}

Unlike the other events, these describe a step that happened, not the current state of the order: an order is not "packed" forever, it was packed at eventDate.

Parcel Events

parcel.created, parcel.updated and parcel.cancelled share the same payload: the parcel as it is now. One event is sent per parcel.

Field	Type	Description
…	Order anchor	The order the parcel belongs to
parcelId	string	The parcel
trackingId	string	The carrier tracking number
status	string	The parcel status
isReturn	boolean	true for a return parcel

{
  "orderId": "…",
  "fulfillmentOrderIds": ["…"],
  "parcelId": "…",
  "trackingId": "6A12345678901",
  "status": "SHIPPED",
  "isReturn": false
}

A cancelled parcel keeps its place: parcel.cancelled carries its new status, and later events about the order still know it.

Payload Objects

Order anchor

Carried by every event, to tell which order it is about.

Field	Type	Description
orderId	string	The order
fulfillmentOrderIds	string[]	Every fulfillment order of the order. Not the one the event is about, when there is one.

Order fields

Field	Type	Description
ref	string	Order reference number
status	string	Current order status
progress	string	Progress of the order: OPENED, IN_PROGRESS, COMPLETED…
service	string	Wing service
organizationService	string	Organization-specific service
organizationId	string	Your organization
tags	string[]	Tags for organizing and filtering orders
isSignatureEnabled	boolean	Delivery against signature
isSaturdayDeliveryEnabled	boolean	Saturday delivery
isInsuranceEnabled	boolean	Insurance
isExternalOrder	boolean	true for an order shipped with a label produced outside Wing
carrierPickupId	string | null	Carrier pickup point (relay point) ID, if applicable
carrierPickupName	string | null	Name of that pickup point
invoiceUrl	string | null	URL to access the order invoice
customLocation	string | null	Custom location information for delivery
warehouseAnomalyToProcessStatus	string	Status of anomalies to be processed
cachedWingWarehouseId	string | null	The Wing warehouse handling the order
cachedOrganizationExpeditorId	string | null	The sender address of your organization used for the order
createdAt	string	ISO 8601 date the order was created in Wing
orderedAt	string	ISO 8601 date the order was placed

Recipient

The recipient as it is now.

Field	Type	Description
cmsId	string | null	The recipient in your e-commerce platform
fullName	string	Full name
firstName	string | null	First name
lastName	string	Last name
company	string | null	Company
phone	string	Phone number
email	string | null	Email address
line1	string	Address, first line
line2	string | null	Address, second line
additional	string | null	Additional address information
city	string	City
zip	string	Postal code
countryCode	string	ISO 3166-1 alpha-2 country code
anonymizedAt	string | null	Set once the recipient has been anonymized: the fields above are then placeholders

Sales channel

Field	Type	Description
channelId	string	Your sales channel in Wing
customerCMSId	string	The order in your e-commerce platform
cmsPartner	string	The e-commerce platform
location	string | null	The platform location the order came from
amazonMarketplaceId	string | null	The Amazon marketplace, for an Amazon order

Collect

A collect the order belongs to.

Field	Type	Description
collectId	string	The collect
status	string	The collect status
organizationPickupId	string	The pickup address of the collect
shouldStartAt	string	ISO 8601 start of the collect time slot
shouldEndAt	string	ISO 8601 end of the collect time slot

Fulfillment order fields

Field	Type	Description
wingRef	string	Wing's reference for the fulfillment order
externalRef	string | null	Your reference for the fulfillment order
status	string	The fulfillment order status
isReturn	boolean	true for a return
isSignatureEnabled	boolean	Delivery against signature
isSaturdayDeliveryEnabled	boolean	Saturday delivery
isInsuranceEnabled	boolean	Insurance
warehouseAnomalyToProcessStatus	string	Status of anomalies to be processed
service	string	The Wing delivery service
carrierPickupId	string | null	The relay point, for a relay delivery
carrierPickupName	string | null	The name of that relay point
invoiceUrl	string | null	The invoice attached to the fulfillment order
customLocation	string | null	Custom location information for delivery
cachedWingWarehouseId	string | null	The Wing warehouse handling the fulfillment order
cachedOrganizationExpeditorId	string | null	The sender address of your organization used for the fulfillment order
linkedFulfillmentOrderId	string | null	The outbound fulfillment order of a return, and the reverse
createdAt	string	ISO 8601 date the fulfillment order was created