--- title: "Order notification" method: POST path: "reservation-serviceReservation order notification" tags: ["Reservations for Platforms"] --- # Order notification `POST reservation-serviceReservation order notification` (webhook) These notifications are sent to the URL provided in the[`orderWebhookUrl` field](https://api-docs.lsk.lightspeed.app/operation/operation-reservation-servicesetbyplatformcode#operation-reservation-servicesetbyplatformcode-body-application-json-orderwebhookurl). ## Payload - ReservationServiceOrderUpdate - `account` ReservationServiceAccount - `accountNumber` string — The unique identifier of the account (order). - `accountObjectId` string — The internal identifier of the table. - `accountProfileCode` string — The code of the [account (order) profile](https://api-docs.lsk.lightspeed.app/operation/operation-reservationordernotification#operation-reservationordernotification-body-application-json-account-accountprofilecode) associated with this order.
See the [order profiles](https://api-portal.lsk.lightspeed.app/guides/definitions/order-profiles) definition for more details. - `accountProfileId` string — The unique identifier of the [account (order) profile](https://api-docs.lsk.lightspeed.app/operation/operation-reservationordernotification#operation-reservationordernotification-body-application-json-account-accountprofilecode) associated with this order. - `accountProfileName` string — The name of the [account (order) profile](https://api-docs.lsk.lightspeed.app/operation/operation-reservationordernotification#operation-reservationordernotification-body-application-json-account-accountprofilecode) associated with this order. - `businessLocationId` string — The unique identifier of the business location. - `closeDate` integer, nullable — The timestamp of when transaction was completed, in milliseconds. - `consumerRecord` ReservationServiceConsumerRecord, nullable - `consumer` ReservationServiceConsumer, nullable - `emailAddress` string - `id` string - `consumerRecordUUID` string, uuid - `contactInformation` ReservationServiceContactInfo - `city` string - `companyName` string - `emailReceipts` boolean — Whether or not email notifications are enabled. - `firstName` string - `fullName` string — Combines `firstName` and `lastName`. - `lastName` string - `taxIdentifier` string - `externalReferences` ReservationServiceExternalConsumerRecord[] — The external reservation system's unique identifier for the consumer. - `key` string — An identifier for the external reservation system. - `reference` string - `id` string - `coverCount` integer — The number of covers associated with the transaction. - `currencyCode` string — The ISO-4217 3 letter currency code. - `currentProductionPhase` integer — The active course. Starts with 0. - `discounts` ReservationServiceDiscount[] - `code` string — The discount code. - `description` string — The name of the discount. - `id` string — The unique identifier of the discount. - `rate` number — The discount rate. - `taxFree` boolean — Indicates if the discount is considered tax free. - `externalReferences` ReservationServiceExternalReference[] — The unique identifiers of this transaction provided by 3rd parties or the K-Series backend. - `prefix` string - `reference` string - `gratuityAmount` number — The tip amount. - `id` string — Legacy account identifier created by the POS (for backwards compatibility). - `latestExternalReferences` ReservationServiceExternalReference[] - `prefix` string - `reference` string - `name` string — The name of the transaction or tab. - `offset` integer — The UTC Offset of the location, in minutes. - `orderMode` 'DIRECT' | 'TABLE' | 'DELIVERY' | 'LOCAL_ORDER' | 'ONLINE' | 'SYSTEM' | 'OTHER' | 'ON_HOLD' | 'CROSS_BL' | 'BAR_TAB' — Order mode of the transaction: * DIRECT – Retail-like direct sale, no table associated * TABLE – Table based order / sale * DELIVERY – Retail-like delivery or take-away sale, no table associated * LOCAL_ORDER – Sale generated by a local order system (e.g. drink dispenser) * ONLINE – Sale generated by a remote order system (e.g. a web site) * SYSTEM – Used for transfer operations between payment methods * ON_HOLD – Direct Sale that is currently put on hold (parked), resumed at a later time * CROSS_BL – Cross business location order - `openDate` integer — The timestamp of when transaction was started, in milliseconds. - `originAccountId` integer, nullable — Legacy reference identifier of origin account created by the POS (for backwards compatibility). - `originAccountNumber` string, nullable — A unique identifier of an account, used to identify sales transactions. - `paidAmount` number — The amount paid. - `paymentLines` ReservationServicePaymentLine[] - `accountId` string — Legacy account identifier created by the POS (supplied because older API provides it to 3rd parties). - `amount` number — Amount given by the customer to settle the transaction. - `currencyCode` string — An ISO-4217 3 letter currency code - `date` integer — Timestamp in ms of the moment when the line was registered. by the user - `gratuityAmount` number — Amount of tip given by the customer using the payment method. - `id` integer — Legacy line identifier created by the POS (supplied because older API provides it to 3rd parties). - `paymentMethod` string — Short code of the payment method the customer used to settle the transaction. - `paymentMethodDescription` string — Name of the payment method used. - `preTaxAmount` number — The amount before tax. - `receiptNumber` string — The unique identifier of the final transaction. - `serviceCharge` number — The sum of all surcharges applied to the transaction. - `staffId` string — The unique identifier of staff member who created/started and owns the transaction. - `staffName` string — The name of staff member who created/started and owns the transaction. - `tableName` string — The name of the table. - `tableNumber` number — Integer number of the table. - `tables` string[] — List of table names (codes) associated with this order - `taxAmount` number — The total amount of tax. - `totalAmount` number — The total amount of the receipt. - `totalDiscount` number — The applied discount rate, as a percentage. - `transactionLines` ReservationServiceTransactionLine[] - `accountId` string — Legacy account identifier created by the POS (supplied because older API provides it to 3rd parties). - `accountingGroupId` string — The unique identifier of the product group assigned to the item. - `accountingGroupName` string — Name of the product group assigned to the item. - `activeTax` ReservationServiceTax - `code` string — Code of the tax as defined in the configuration context. - `description` string — Name of the tax as defined in the configuration context. - `rate` number, double — Tax percentage (e.g. 19% => '1.19'). - `taxIncluded` boolean — Indicates whether the tax is VAT or Sales Tax. - `amount` number — The actual (final) amount the customer will be charged, ie. `regularAmount` with `modifiers` applied. - `amountLessTax` number — Taxable amount not including any taxes. - `amountWithTax` number — Final amount including taxes. - `categories` ReservationServiceCategory[] — A list of the reporting categories in which the sale is to be aggregated. - `category` string — The reporting category name. - `value` string — The reporting category value. - `date` integer — Timestamp in ms of the moment when the line was registered. by the user - `discountedAmount` number — The line discount amount applied to the line. - `grossUnitAmount` number — Regular price for one unit of the line item. - `id` string — Legacy line identifier created by the POS (supplied because older API provides it to 3rd parties). - `itemDescription` string — Name of the item sold. - `itemId` string — The unique identifier of the item at the business location. - `itemSku` string — SKU (stock keeping unit) of the item. - `modifiers` ReservationServiceModifier[] — A production instruction entered for a line. - `name` string — Line text. - `quantity` integer — Line quantity. - `nameOverride` string — Manually entered item name - `phase` integer — Course number assigned to the line. - `quantity` number — Quantity - `tags` string — Array of tags associated with the sales line. - `unitAmount` number — Actual amount for one unit of the line item including all markup, markdowns & surcharges. - `type` string — The sale line type. - `updateDate` integer — The timestamp of when the complete update was finalized at the POS, in milliseconds. - `businessLocationId` integer — The unique identifier of the business location. - `notificationType` 'OPEN' | 'UPDATE' | 'CLOSE' | 'CANCEL' - `platformRestaurantId` string — The external platform's unique identifier for the restaurant. - `sequenceId` string - `platformReservationId` string — The external platform's unique identifier for the reservation. - `platformCode` string — The unique code assigned to the reservation platform. ## 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/96f04e4e3f61/schema)