Sign in
OpenAPI 3.1.02026-08-12911,252858.9 KB

96f04e4e3f61

Order and Pay

Create To Go Order

Creates a new takeaway or delivery order for a specific business location. See Online Ordering Basics for more details.

post/o/op/1/order/toGo

Request body

businessLocationIdinteger required

The unique identifier for the business location.

thirdPartyReferencestring required

The external reference provided for this order. Must be unique. This value will be included in the order details sent to the webhook URL.

endpointIdstring required

Endpoint id for a unique webhook that has been created using the webhook endpoint.

orderNotestring

A note added to this order and displayed on the printed dockets.

maxTimeToAttemptOrderDeliverToPosinteger

** Use of this feature is strongly recommended **

Maximum time to attempt delivery of this order to the POS. In milliseconds. The minimum value is 60000ms (1 minute).

If scheduledTimeForOrderAsIso8601 is used, this value will be added to the scheduled order time.

staffIdinteger

The unique identifier for the staff member.

accountProfileCodestring

A valid order profile code to associate with this order. See the order profiles definition for more details.

scheduledTimeForOrderAsIso8601string date-time

The time that the order will be sent to the POS. Must be in the future.

collectionCodestring

Unique collection code for this order. If left blank, one will be automatically generated.

orderCollectionTimeAsIso8601string date-time

The expected collection time of the order. Must be in the future.

targetPrinterProfileIdinteger

The printer profile id to use for printing the receipt for this payment. If not provided, the default active printer profile for the business location will be used.

Example request

{
  "businessLocationId": 45454565682155,
  "thirdPartyReference": "MyAwesomeThirdPartyReference",
  "endpointId": "MY-AWESOME-ENDPOINT-ID",
  "customerInfo": {
    "firstName": "Jane",
    "lastName": "Doe",
    "thirdPartyReference": "ZEN-7074522d-c71d-403f",
    "email": "jane.doe@example.com",
    "contactNumberAsE164": "+14155552671",
    "notes": "Notes about the customer.",
    "salutation": "Mr.",
    "sendEmailReceipts": true
  },
  "orderNote": "Sample Order Note",
  "maxTimeToAttemptOrderDeliverToPos": 60000,
  "staffId": 1234567890,
  "accountProfileCode": "TOGOORDER",
  "scheduledTimeForOrderAsIso8601": "2024-04-04T09:42:00.000+00:00",
  "payment": {
    "paymentMethod": "OOPAYMENT",
    "paymentAmount": 14,
    "tipAmount": 2
  },
  "collectionCode": "12345",
  "orderCollectionTimeAsIso8601": "2024-04-04T09:42:00.000+00:00",
  "items": [
    {
      "quantity": 1,
      "sku": "UGG-BB-PUR-06",
      "customItemName": "My Custom Item Name",
      "customItemPrice": 10,
      "discountAmountOverride": 5,
      "discountPercentOverride": 10,
      "modifiers": [
        {
          "modifierId": "236025632784492"
        }
      ],
      "discountCode": "FIVEPERCENT",
      "subItems": [
        {
          "quantity": 1,
          "sku": "ABC-123",
          "customItemName": "My Custom Sub-Item Name",
          "customItemPrice": 2,
          "modifiers": [
            {
              "modifierId": "236025632784492"
            }
          ]
        }
      ]
    }
  ],
  "targetPrinterProfileId": 1773881235
}

Response

accepted

statusstring

The response.

Example response

{
  "status": "ok"
}