Notifications order

POST https://webhook.example.com

What your webhook implementation will receive when placing an order

application/json

Body Required

  • reason string

    Reason for failure if there is one

  • Third-party reference you provided when the order or payment was placed.

  • businessLocationId integer(int64)

    The unique identifier of the business location.

  • The K-series account identifier for a SUCCESS event (V3 format)

  • iKentooAccountId integer(int64) Deprecated

    The K-series account identifier for a SUCCESS event (V2 format)

  • status string

    Status of the order operation.

    Values are SUCCESS, FAILURE, IN_DELIVERY, READY_FOR_PICKUP, CLOSED, ABANDONED, or CANCELLED.

  • type string

    Notification type

    Default value is ORDER.

  • account object
    Hide account attributes Show account attributes

Responses

  • Your server returns this code if it accepts the callback

POST Order notification
{
  "type": "ORDER",
  "status": "SUCCESS",
  "ikentooAccountId": "2114502594134196",
  "thirdPartyReference": "REF11",
  "ikentooAccountIdentifier": "A123080.14"
}
{
  "type": "ORDER",
  "status": "READY_FOR_PICKUP",
  "account": {
    "name": "Order NZVV",
    "uuid": "5a81c7f4-9e2f-4db2-965d-6946a4f9c25b",
    "posId": 17700,
    "staffId": 31930,
    "openDate": "2021-12-21T13:24:49.265+0000",
    "staffName": "Manager",
    "paidAmount": "4.00",
    "clientCount": 2,
    "ikaccountId": "A17700.3",
    "tableNumber": 3,
    "salesEntries": [
      {
        "id": 304087979524125,
        "active": true,
        "itemSku": "21",
        "itemName": "Appetizer 2",
        "quantity": 1,
        "modifiers": [],
        "unitAmount": "4.00",
        "taxIncluded": true,
        "amountLessTax": "3.33",
        "amountWithTax": "4.00",
        "grossUnitAmount": "4.00",
        "discountedAmount": "0.00"
      }
    ],
    "currentAmount": "4.00",
    "serviceCharge": "0.00",
    "paymentEntries": [
      {
        "active": true,
        "amountPaid": "4.00",
        "paymentDate": "2021-12-21T13:25:25.082+0000",
        "externalReference": "1234567890",
        "paymentMethodCode": "APM",
        "paymentMethodDescription": "API Payment"
      }
    ]
  },
  "ikentooAccountId": 304087979524124,
  "businessLocationId": 247158188015618,
  "thirdPartyReference": "order-wFUBVgHNGPAJsryIrSaE",
  "ikentooAccountIdentifier": "A17700.3"
}
{
  "reason": "A consumer already exists for this email address with a different external reference.",
  "status": "FAILURE",
  "thirdPartyReference": "REF12212"
}
{
  "type": "ORDER",
  "status": "SUCCESS",
  "account": {
    "name": "Order NZVV",
    "uuid": "5a81c7f4-9e2f-4db2-965d-6946a4f9c25b",
    "posId": 17700,
    "staffId": 31930,
    "openDate": "2021-12-21T13:24:49.265+0000",
    "staffName": "Online Order",
    "paidAmount": "0.00",
    "clientCount": 2,
    "ikaccountId": "A17700.3",
    "tableNumber": 3,
    "salesEntries": [
      {
        "id": 304087979524125,
        "uuid": "1b8d016e-2c7f-456d-9349-8476eacd99bf",
        "active": true,
        "itemSku": "21",
        "itemName": "Appetizer 2",
        "quantity": 1,
        "modifiers": [],
        "unitAmount": "4.00",
        "taxIncluded": true,
        "subLineItems": [],
        "amountLessTax": "3.33",
        "amountWithTax": "4.00",
        "grossUnitAmount": "4.00",
        "discountedAmount": "0.00",
        "timeOfTransactionUtc": "2023-11-08T13:33:52.641+0000"
      }
    ],
    "currentAmount": "4.00",
    "serviceCharge": "0.00",
    "paymentEntries": []
  },
  "ikentooAccountId": 304087979524124,
  "businessLocationId": 247158188015618,
  "thirdPartyReference": "order-wFUBVgHNGPAJsryIrSaE",
  "ikentooAccountIdentifier": "A17700.3"
}
{
  "type": "ORDER",
  "status": "CHECK_WAS_UPDATED",
  "account": {
    "name": "Order NZVV",
    "uuid": "5a81c7f4-9e2f-4db2-965d-6946a4f9c25b",
    "posId": 17700,
    "staffId": 31930,
    "openDate": "2021-12-21T13:24:49.265+0000",
    "staffName": "Manager",
    "paidAmount": "4.00",
    "clientCount": 2,
    "ikaccountId": "A17700.3",
    "tableNumber": 3,
    "salesEntries": [
      {
        "id": 304087979524125,
        "active": true,
        "itemSku": "21",
        "itemName": "Appetizer 2",
        "quantity": 1,
        "modifiers": [],
        "unitAmount": "4.00",
        "taxIncluded": true,
        "amountLessTax": "3.33",
        "amountWithTax": "4.00",
        "grossUnitAmount": "4.00",
        "discountedAmount": "0.00"
      }
    ],
    "currentAmount": "4.00",
    "serviceCharge": "0.00",
    "paymentEntries": [
      {
        "active": true,
        "amountPaid": "4.00",
        "paymentDate": "2021-12-21T13:25:25.082+0000",
        "externalReference": "1234567890",
        "paymentMethodCode": "APM",
        "paymentMethodDescription": "API Payment"
      }
    ]
  },
  "ikentooAccountId": 304087979524124,
  "businessLocationId": 247158188015618,
  "thirdPartyReference": "order-wFUBVgHNGPAJsryIrSaE",
  "ikentooAccountIdentifier": "A17700.3"
}
{
  "type": "ORDER",
  "status": "CLOSED",
  "account": {
    "name": "Order NZVV",
    "uuid": "5a81c7f4-9e2f-4db2-965d-6946a4f9c25b",
    "posId": 17700,
    "staffId": 31930,
    "openDate": "2021-12-21T13:24:49.265+0000",
    "staffName": "Manager",
    "paidAmount": "4.00",
    "clientCount": 2,
    "ikaccountId": "A17700.3",
    "tableNumber": 3,
    "salesEntries": [
      {
        "id": 304087979524125,
        "active": true,
        "itemSku": "21",
        "itemName": "Appetizer 2",
        "quantity": 1,
        "modifiers": [],
        "unitAmount": "4.00",
        "taxIncluded": true,
        "amountLessTax": "3.33",
        "amountWithTax": "4.00",
        "grossUnitAmount": "4.00",
        "discountedAmount": "0.00"
      }
    ],
    "currentAmount": "4.00",
    "serviceCharge": "0.00",
    "paymentEntries": [
      {
        "active": true,
        "amountPaid": "4.00",
        "paymentDate": "2021-12-21T13:25:25.082+0000",
        "externalReference": "1234567890",
        "paymentMethodCode": "APM",
        "paymentMethodDescription": "API Payment"
      }
    ]
  },
  "ikentooAccountId": 304087979524124,
  "businessLocationId": 247158188015618,
  "thirdPartyReference": "order-wFUBVgHNGPAJsryIrSaE",
  "ikentooAccountIdentifier": "A17700.3"
}