Skip to main content
The OrderStatusUpdate event fires whenever the status or fulfillmentStatus field on an existing order is changed — for example, when a pending order is marked as completed or when fulfillment is initiated. Use this event to keep external fulfillment systems, dashboards, and customer communications in sync with the current order state.

​
Payload

FieldTypeDescription
typestringAlways "OrderStatusUpdate"
locationIdstringSub-account ID where the order resides
_idstringUnique identifier for the order
altIdstringSub-account (location) ID — matches locationId
altTypestringResource type for altId — always "location"
statusstringUpdated order payment status (e.g., pending, completed)
fulfillmentStatusstringUpdated shipping/fulfillment status (e.g., unfulfilled, fulfilled)
contactIdstringID of the contact who placed the order
contactSnapshotobjectPoint-in-time snapshot of the contact at the time of the update
currencystringISO 4217 currency code (e.g., USD)
amountnumberTotal order amount including tax and shipping
liveModebooleantrue when the event originates from a live sub-account; false in test mode
itemsarrayLine items in the order
amountSummaryobjectBreakdown of the order total (subtotal, discount, tax, shipping)
taxSummaryarrayPer-tax-rule breakdown
sourceobjectOrigin of the order (type, subType, id, name)
createdAtstringISO 8601 timestamp when the order was originally created
updatedAtstringISO 8601 timestamp of this status update

​
Example payload

{
  "type": "OrderStatusUpdate",
  "locationId": "Z4Bxl8J4SaPEPLq9IQ8g",
  "_id": "660ed43bfdf9fc05a0de7a40",
  "altId": "Z4Bxl8J4SaPEPLq9IQ8g",
  "altType": "location",
  "status": "completed",
  "fulfillmentStatus": "unfulfilled",
  "contactId": "ff2JstbQJfRuofXzeT0M",
  "currency": "USD",
  "amount": 150.1,
  "liveMode": false,
  "amountSummary": {
    "subtotal": 138,
    "discount": 0,
    "tax": 12.1,
    "shipping": 0
  },
  "createdAt": "2024-04-04T16:24:27.036Z",
  "updatedAt": "2024-04-04T16:24:31.297Z"
}
Last modified on March 4, 2026