All Versions

Order created BETA

EVENT order.created

Published when an Order is created. This event is triggered only by the CreateOrder endpoint call.

Creating an order in the Point of Sale app will not publish this event.

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.created"`.
`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 OrderCreatedSquareEventData`	Data associated with the event.

Examples

All Versions

{
  "merchant_id": "5S9MXCS9Y99KK",
  "type": "order.created",
  "event_id": "116038d3-2948-439f-8679-fc86dbf80f69",
  "created_at": "2020-04-16T23:14:26.129Z",
  "data": {
    "type": "order",
    "id": "eA3vssLHKJrv9H0IdJCM3gNqfdcZY",
    "object": {
      "order_created": {
        "created_at": "2020-04-16T23:14:26.129Z",
        "location_id": "FPYCBCHYMXFK1",
        "order_id": "eA3vssLHKJrv9H0IdJCM3gNqfdcZY",
        "state": "OPEN",
        "version": 1
      }
    }
  }
}