Get Sample Order Notification

GET /reservation/api/1/platform/{platform-code}/order-webhook-sample

Returns an example of an order update notification. These notifications are sent to the URL provided in the orderWebhookUrl field.

Path parameters

platform-code string Required

The unique code assigned to the reservation platform.

Maximum length is 11. Format should match the following pattern: [a-zA-Z0-9_-]+.

Responses

• 200 application/json

OK
Hide response attributes Show response attributes object
- notificationType string
  
  Values are OPEN, UPDATE, CLOSE, or CANCEL.
- account object
  
  Hide account attributes Show account attributes
  
  id string
  
  Legacy account identifier created by the POS (for backwards compatibility).
  
  businessLocationId string
  
  The unique identifier of the business location.
  
  name string
  
  The name of the transaction or tab.
  
  accountNumber string
  
  The unique identifier of the account.
  
  currencyCode string
  
  The ISO-4217 3 letter currency code.
  
  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.
  
  openDate integer(int64)
  
  The timestamp of when transaction was started, in milliseconds.
  
  closeDate integer(int64) | null
  
  The timestamp of when transaction was completed, in milliseconds.
  
  paidAmount number
  
  The amount paid.
  
  totalAmount number
  
  The total amount of the receipt.
  
  coverCount integer(int64)
  
  The number of covers associated with the transaction.
  
  gratuityAmount number
  
  The tip amount.
  
  receiptNumber string
  
  The receipt id of the final transaction.
  
  accountObjectId string
  
  The internal identifier of the table.
  
  latestExternalReferences array[object]
  
  The unique identifier of this transaction provided by 3rd parties or the K-Series backend.
  
  Hide latestExternalReferences attributes Show latestExternalReferences attributes object
  
  prefix string
  
  reference string
  
  taxAmount number
  
  The total amount of tax.
  
  preTaxAmount number
  
  The amount before tax.
  
  serviceCharge number
  
  The sum of all surcharges applied to the transaction.
  
  tableName string
  
  The name of the table.
  
  accountProfileCode string
  
  The code of the account profile associated with this order.
  See the account profiles definition for more details.
  
  accountProfileName string
  
  The name of the account profile associated with this order.
  
  accountProfileId string
  
  The id of the account profile associated with this order.
  
  originAccountId integer(int64) | null
  
  Legacy reference id of origin account created by the POS (for backwards compatibility).
  
  originAccountNumber string | null
  
  A unique identifier of an account, used as an id for sales transactions.
  
  type string
  
  The sale line type.
  
  updateDate integer(int64)
  
  The timestamp of when the complete update was finalized at the POS, in milliseconds.
  
  offset integer(int32)
  
  The UTC Offset of the location, in minutes.
  
  totalDiscount number
  
  The applied discount rate, as a percentage.
  
  transactionLines array[object]
  
  Hide transactionLines attributes Show transactionLines attributes object
  
  id string
  
  Legacy line id created by the POS (supplied because older API provides it to 3rd parties)
  
  accountId string
  
  Legacy account id created by the POS (supplied because older API provides it to 3rd parties)
  
  amount number
  
  The actual (final) amount the customer will be charged, so regularAmount with modifiers applied
  
  unitAmount number
  
  Actual amount for one unit of the line item including all markup, markdowns & surcharges
  
  quantity number
  
  Quantity
  
  nameOverride string
  
  Manually entered item name
  
  itemDescription string
  
  Name of the item sold
  
  accountingGroupId string
  
  Id of the product group that's assigned to the item
  
  accountingGroupName string
  
  Name of the product group that's assigned to the item
  
  itemId string
  
  ID of the item at the business location
  
  itemSku string
  
  SKU (stock keeping unit) of the item
  
  date integer(int64)
  
  Timestamp in ms of the moment when the line was registered by the user
  
  tags string
  
  Array of tags associated with the sales line
  
  phase integer(int32)
  
  Course number assigned to the line
  
  categories array[object]
  
  A list of the reporting categories in which the sale is to be aggregated.
  
  Hide categories attributes Show categories attributes object
  
  category string
  
  The reporting category name.
  
  value string
  
  The reporting category value.
  
  amountWithTax number
  
  Final amount including taxes
  
  amountLessTax number
  
  Taxable amount not including any taxes
  
  discountedAmount number
  
  The line discount amount applied to the line
  
  grossUnitAmount number
  
  Regular price for one unit of the line item
  
  activeTax object
  
  Hide activeTax attributes Show activeTax attributes
  
  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
  
  modifiers array[object]
  
  A production instruction entered for a line
  
  Hide modifiers attributes Show modifiers attributes object
  
  quantity integer(int64)
  
  Line quantity
  
  name string
  
  Line text
  
  paymentLines array[object]
  
  Hide paymentLines attributes Show paymentLines attributes object
  
  id integer(int64)
  
  Legacy line id created by the POS (supplied because older API provides it to 3rd parties)
  
  accountId string
  
  Legacy account id created by the POS (supplied because older API provides it to 3rd parties)
  
  currencyCode string
  
  An ISO-4217 3 letter currency code
  
  gratuityAmount number
  
  Amount of tip given by the customer using the payment method
  
  amount number
  
  Amount given by the customer to settle the transaction
  
  date integer(int64)
  
  Timestamp in ms of the moment when the line was registered by the user
  
  paymentMethod string
  
  Short code of the payment method the customer used to settle the transaction
  
  paymentMethodDescription string
  
  Name of the payment method used
  
  discounts array[object]
  
  Hide discounts attributes Show discounts attributes object
  
  id string
  
  The unique identifier of the discount.
  
  code string
  
  The discount code.
  
  description string
  
  The name of the discount.
  
  rate number
  
  The discount rate.
  
  taxFree boolean
  
  Indicates if the discount is considered tax free.
  
  externalReferences array[object]
  
  The unique identifier of this transaction provided by 3rd parties or the K-Series backend.
  
  Hide externalReferences attributes Show externalReferences attributes object
  
  prefix string
  
  reference string
  
  consumerRecord object | null
  
  Hide consumerRecord attributes Show consumerRecord attributes
  
  id string
  
  consumerRecordUUID string(uuid)
  
  consumer object | null
  
  Hide consumer attributes Show consumer attributes
  
  id string
  
  emailAddress string
  
  contactInformation object
  
  Hide contactInformation attributes Show contactInformation attributes
  
  firstName string
  
  lastName string
  
  companyName string
  
  city string
  
  taxIdentifier string
  
  emailReceipts boolean
  
  Whether or not email notifications are enabled.
  
  fullName string
  
  Combines firstName and lastName.
  
  externalReferences array[object]
  
  The external reservation system's unique identifier for the consumer.
  
  Hide externalReferences attributes Show externalReferences attributes object
  
  key string
  
  An identifier for the external reservation system.
  
  reference string
  
  currentProductionPhase integer(int32)
  
  The active course. Starts with 0.
- businessLocationId integer(int64)
  
  The K-Series business location ID.
- platformRestaurantId string
  
  The external platform ID for the restaurant.
  
  Format should match the following pattern: [a-zA-Z0-9_-]+.
- sequenceId string

GET /reservation/api/1/platform/{platform-code}/order-webhook-sample

curl \
 -X GET https://api.lsk.lightspeed.app/reservation/api/1/platform/MyPlatform/order-webhook-sample \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "notificationType": "CLOSE",
  "account": {
    "id": "612329192423425",
    "businessLocationId": "22187801052649",
    "name": "Bar, Table 1",
    "accountNumber": "A35642.1",
    "currencyCode": "USD",
    "staffId": "2823",
    "staffName": "John.Cena",
    "openDate": 1711550514875,
    "closeDate": 1711550589647,
    "paidAmount": 9.1,
    "totalAmount": 9.1,
    "coverCount": 1,
    "gratuityAmount": 0,
    "receiptNumber": "R35642.1",
    "accountObjectId": "22187801053871",
    "taxAmount": 0.6,
    "preTaxAmount": 8.5,
    "serviceCharge": 0,
    "tableName": "Table 1",
    "accountProfileCode": "Reservation",
    "accountProfileName": "Reservation",
    "accountProfileId": "22187801053876",
    "originAccountId": null,
    "originAccountNumber": null,
    "type": "SALE",
    "updateDate": 1711550514914,
    "offset": 240,
    "totalDiscount": 0,
    "transactionLines": [
      {
        "id": "612329192423428",
        "accountId": "612329192423425",
        "amount": 4,
        "unitAmount": 4,
        "quantity": 1,
        "nameOverride": "",
        "itemDescription": "French Fries",
        "accountingGroupId": "22187801051201",
        "accountingGroupName": "Food",
        "itemId": "22187801052783",
        "itemSku": "69",
        "date": 1711550534347,
        "tags": "",
        "phase": 0,
        "categories": [
          {
            "category": "default",
            "value": "Food"
          }
        ],
        "amountWithTax": 4.28,
        "amountLessTax": 4,
        "discountedAmount": 0,
        "grossUnitAmount": 4,
        "activeTax": {
          "code": "STAX",
          "description": "7% State Tax",
          "rate": 1.07,
          "taxIncluded": false
        },
        "subLines": [],
        "modifiers": []
      },
      {
        "id": "612329192423429",
        "accountId": "612329192423425",
        "amount": 4.5,
        "unitAmount": 4.5,
        "quantity": 1,
        "nameOverride": "",
        "itemDescription": "Heinenken",
        "accountingGroupId": "22187801051191",
        "accountingGroupName": "Alcoholic beverages",
        "itemId": "22187801053839",
        "itemSku": "676",
        "date": 1711550553193,
        "tags": "",
        "phase": 0,
        "categories": [
          {
            "category": "something else",
            "value": "Alcoholic beverages"
          }
        ],
        "amountWithTax": 4.82,
        "amountLessTax": 4.5,
        "discountedAmount": 0,
        "grossUnitAmount": 4.5,
        "activeTax": {
          "code": "STAX",
          "description": "7% State Tax",
          "rate": 1.07,
          "taxIncluded": false
        },
        "subLines": [],
        "modifiers": []
      }
    ],
    "paymentLines": [
      {
        "id": 612329192423431,
        "accountId": "612329192423425",
        "currencyCode": "USD",
        "gratuityAmount": 0,
        "amount": 9.1,
        "date": 1711550589607,
        "paymentMethod": "CASH",
        "paymentMethodDescription": "Cash"
      }
    ],
    "discounts": [],
    "externalReferences": [
      {
        "prefix": "TASK",
        "reference": "RN-22187801052649-test4#2ed4c054-53cf-4b03-90f8-58be424ee31"
      }
    ],
    "consumerRecord": {
      "id": "44136",
      "consumerRecordUUID": "8210bb3b-0916-4cd4-8fb5-859fdb5f863b",
      "consumer": null,
      "contactInformation": {
        "firstName": "Evgeny",
        "lastName": "Onegin",
        "companyName": "",
        "city": "",
        "taxIdentifier": "",
        "emailReceipts": false,
        "fullName": "Evgeny Onegin"
      },
      "externalReferences": [
        {
          "key": "test4",
          "reference": "OO.1291.1"
        }
      ]
    },
    "currentProductionPhase": 0
  },
  "businessLocationId": 22187801052649,
  "platformRestaurantId": "123451234",
  "sequenceId": "B35642.15",
  "platformReservationId": "2ed4c054-53cf-4b03-90f8-58be424ee31"
}