All Versions

Order fulfillment updated BETA

EVENT order.fulfillment.updated

Published when an OrderFulfillment is created or updated. This event is triggered only by the UpdateOrder endpoint call.

Permissions

ORDERS_READ

Event payload

Example code

Name	Description
`merchant_id string`	The ID of the target merchant associated with the event.
`type string`	The type of event this represents, `"order.fulfillment.updated"`.
`event_id string`	A unique ID for the event.
`created_at string`	Read only Timestamp of when the event was created, in RFC 3339 format. Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00
`data OrderFulfillmentUpdatedSquareEventData`	Data associated with the event.

Examples

All Versions

{
  "merchant_id": "5S9MXCS9Y99KK",
  "type": "order.fulfillment.updated",
  "event_id": "b3adf364-4937-436e-a833-49c72b4baee8",
  "created_at": "2020-04-16T23:16:30.789Z",
  "data": {
    "type": "order",
    "id": "eA3vssLHKJrv9H0IdJCM3gNqfdcZY",
    "object": {
      "order_fulfillment_updated": {
        "created_at": "2020-04-16T23:14:26.129Z",
        "fulfillment_update": [
          {
            "fulfillment_uid": "VWJ1N9leLqjSDLvF2hvYjD",
            "new_state": "RESERVED",
            "old_state": "PROPOSED"
          }
        ],
        "location_id": "FPYCBCHYMXFK1",
        "order_id": "eA3vssLHKJrv9H0IdJCM3gNqfdcZY",
        "state": "OPEN",
        "updated_at": "2020-04-16T23:16:30.789Z",
        "version": 6
      }
    }
  }
}