• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”
You are viewing an old version of the API

Order updated BETA

EVENT order.updated

Published when an Order is updated. This event is triggered only by the UpdateOrder endpoint call.

Required permissions: ORDERS_READ

Event payload

Name Description
merchant_id
string

The ID of the target merchant associated with the event.

type
string

The type of event this represents, "order.updated".

event_id
string

A unique ID for the webhook event.

created_at
string

Timestamp of when the webhook event was created, in RFC 3339 format.

Examples for January 25th, 2020 6:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

data
OrderUpdatedWebhookData

Data associated with the event.

Examples

You are viewing an old version of the API
Example payload
{
  "merchant_id": "5S9MXCS9Y99KK",
  "type": "order.updated",
  "event_id": "4b8e5c91-9f17-4cf1-900a-4a0629f81add",
  "created_at": "2020-04-16T23:14:26.359Z",
  "data": {
    "type": "order",
    "id": "eA3vssLHKJrv9H0IdJCM3gNqfdcZY",
    "object": {
      "order_updated": {
        "created_at": "2020-04-16T23:14:26.129Z",
        "location_id": "FPYCBCHYMXFK1",
        "order_id": "eA3vssLHKJrv9H0IdJCM3gNqfdcZY",
        "state": "OPEN",
        "updated_at": "2020-04-16T23:14:26.359Z",
        "version": 2
      }
    }
  }
}

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?