---
title: "Order Notification"
method: POST
path: "apeOrder notification"
tags: ["Order and Pay"]
---

# Order Notification

`POST apeOrder notification` (webhook)

What your webhook implementation will receive when placing an order

## Payload

- object
  - `reason` string — Reason for failure if applicable.
  - `thirdPartyReference` string — Third-party reference you provided when the order or payment was placed.
  - `businessLocationId` integer — The unique identifier for the business location.
  - `ikentooAccountIdentifier` string — The K-series account identifier for a SUCCESS event (V3 format)
  - `iKentooAccountId` integer — The K-series account identifier for a SUCCESS event (V2 format)
  - `status` 'SUCCESS' | 'FAILURE' | 'IN_DELIVERY' | 'READY_FOR_PICKUP' | 'CLOSED' | 'ABANDONED' | 'CANCELLED' — Status of the order operation.
  - `type` string — Notification type
  - `account` object — Related account (if the webhook is configured to provide it)
    - `clientCount` integer — The number of guests at the table.
    - `identifier` string
    - `uuid` string — The account uuid.
    - `openDate` string, date-time — The date this account was opened in UTC.
    - `closeDate` string, date-time — The date this account was closed in UTC.
    - `paidAmount` number — The total of all payments on the check.
    - `serviceCharge` number — The service charge applied to the check.
    - `name` string — The check name.
    - `currentAmount` number — The current total amount on the check.
    - `staffName` string — The name of the staff member assigned to the check.
    - `staffId` integer — The unique ID of the staff member assigned to the check.
    - `salesEntries` ApeAccountLineItem[] — Collection of check items.
      - `id` integer — The unique ID assigned to the sale line.
      - `uuid` string — The UUID assigned to the sale line.
      - `itemName` string — The name given to the item.
      - `itemSku` string — The SKU assigned to the item.
      - `unitAmount` number — The price per unit.
      - `quantity` number, double — The quantity of the item for this sale line.
      - `modifiers` ApeModifier[] — The modifiers of the item for this sale line.
        - `name` string — The name of the modifier.
        - `quantity` integer — The quantity of the modifier.
      - `amountWithTax` number — The total price of the item including tax.
      - `amountLessTax` number — The total price of the item without tax.
      - `discountedAmount` number — The amount the item was discounted.
      - `timeOfTransactionUtc` string, date-time — The date and time in UTC when the transaction occurred.
      - `active` boolean
      - `parentId` integer
      - `subLineItems` ApeAccountLineItem[] — Collection of sub-line items associated with this sale line.
      - `isTaxIncluded` boolean
      - `taxIncluded` boolean — Indicates whether tax is included in the unit amount.
    - `paymentEntries` ApeAccountPaymentLine[] — Collection of payment entries to the check.
      - `paymentMethodDescription` string — Payment method for this payment line.
      - `externalReference` string — Payment external reference.
      - `paymentMethodCode` string — Payment method code for this payment line.
      - `amountPaid` number — Amount paid for this payment line.
      - `paymentDate` string, date-time — Date/Time in UTC of this payment.
      - `active` boolean — Whether this payment line is active or not.
      - `accountCancelled` boolean
    - `id` string
    - `ikaccountId` string — The system-generated account identifier for this check.(Applies to iKentoo V3+).
    - `number` integer
    - `tableNumber` integer — The table number assigned to the check.
    - `posId` integer — The unique ID of the POS station that processed the check.
    - `deviceId` integer

## Acknowledgement `200`

Your server returns this code if it accepts the callback

---

[API](https://skmtc.net/lightspeed/apis/lightspeed-restaurant-k-series-api.md) · [All operations](https://skmtc.net/lightspeed/apis/lightspeed-restaurant-k-series-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightspeed/lightspeed-restaurant-k-series-api/revisions/0e481cddec74/schema)