Sign in
OpenAPI 3.1.02026-08-12911,252858.9 KB

96f04e4e3f61

Order and Pay

Create Local Order

Creates a new dine-in order for a specific business location. See Online Ordering Basics for more details.

If the accountIdentifier of an existing order is provided in the body of the request, the request will update the existing order.

post/o/op/1/order/local

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.

accountIdstring

The system-generated account identifier for this order (Applies to iKentoo V2). If this is specified, the associated order will be updated.

accountIdentifierstring

The system-generated account identifier for this order (Applies to iKentoo V3+). If this is specified, the associated order will be updated.

tableNumberstring

The table number for this local order. If updating an existing order, (ie.accountIdentifier is specified), the tableNumber cannot be updated.

clientCountinteger

The number of customers for this order. If updating an existing order, (ie.accountIdentifier is specified), the clientCount cannot be updated.

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": "LOCALORDER",
  "scheduledTimeForOrderAsIso8601": "2024-04-04T09:42:00.000+00:00",
  "payment": {
    "paymentMethod": "OOPAYMENT",
    "paymentAmount": 14,
    "tipAmount": 2
  },
  "accountId": "1234567890",
  "accountIdentifier": "A1235.89",
  "tableNumber": "1",
  "clientCount": 4,
  "items": [
    {
      "quantity": 1,
      "sku": "UGG-BB-PUR-06",
      "customItemName": "My Custom Item Name",
      "customItemPrice": 10,
      "discountAmountOverride": 5,
      "discountPercentOverride": 10,
      "modifiers": [
        {
          "modifierId": "236025632784492"
        }
      ],
      "discountCode": "FIVEPERCENT",
      "course": 2,
      "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"
}