Get Sample Order Notification
Returns an example of an order update notification. These notifications are sent to the URL provided in the orderWebhookUrl
field.
Path parameters
-
The unique code assigned to the reservation platform.
Maximum length is
11
. Format should match the following pattern:[a-zA-Z0-9_-]+
.
GET /reservation/api/1/platform/{platform-code}/order-webhook-sample
curl \
-X GET https://api.trial.lsk.lightspeed.app/reservation/api/1/platform/MyPlatform/order-webhook-sample \
-H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
"account": {
"id": "612329192423425",
"name": "Bar, Table 1",
"type": "SALE",
"offset": 240,
"staffId": "2823",
"openDate": 1711550514875,
"closeDate": 1711550589647,
"discounts": [],
"staffName": "John.Cena",
"tableName": "Table 1",
"taxAmount": 0.6,
"coverCount": 1,
"paidAmount": 9.1,
"updateDate": 1711550514914,
"tableNumber": 1,
"totalAmount": 9.1,
"currencyCode": "USD",
"paymentLines": [
{
"id": 612329192423431,
"date": 1711550589607,
"amount": 9.1,
"accountId": "612329192423425",
"currencyCode": "USD",
"paymentMethod": "CASH",
"gratuityAmount": 0,
"paymentMethodDescription": "Cash"
}
],
"preTaxAmount": 8.5,
"accountNumber": "A35642.1",
"receiptNumber": "R35642.1",
"serviceCharge": 0,
"totalDiscount": 0,
"consumerRecord": {
"id": "44136",
"consumer": null,
"consumerRecordUUID": "8210bb3b-0916-4cd4-8fb5-859fdb5f863b",
"contactInformation": {
"city": "",
"fullName": "Evgeny Onegin",
"lastName": "Onegin",
"firstName": "Evgeny",
"companyName": "",
"emailReceipts": false,
"taxIdentifier": ""
},
"externalReferences": [
{
"key": "test4",
"reference": "OO.1291.1"
}
]
},
"gratuityAmount": 0,
"accountObjectId": "22187801053871",
"originAccountId": null,
"accountProfileId": "22187801053876",
"transactionLines": [
{
"id": "612329192423428",
"date": 1711550534347,
"tags": "",
"phase": 0,
"amount": 4,
"itemId": "22187801052783",
"itemSku": "69",
"quantity": 1,
"subLines": [],
"accountId": "612329192423425",
"activeTax": {
"code": "STAX",
"rate": 1.07,
"description": "7% State Tax",
"taxIncluded": false
},
"modifiers": [],
"categories": [
{
"value": "Food",
"category": "default"
}
],
"unitAmount": 4,
"nameOverride": "",
"amountLessTax": 4,
"amountWithTax": 4.28,
"grossUnitAmount": 4,
"itemDescription": "French Fries",
"discountedAmount": 0,
"accountingGroupId": "22187801051201",
"accountingGroupName": "Food"
},
{
"id": "612329192423429",
"date": 1711550553193,
"tags": "",
"phase": 0,
"amount": 4.5,
"itemId": "22187801053839",
"itemSku": "676",
"quantity": 1,
"subLines": [],
"accountId": "612329192423425",
"activeTax": {
"code": "STAX",
"rate": 1.07,
"description": "7% State Tax",
"taxIncluded": false
},
"modifiers": [],
"categories": [
{
"value": "Alcoholic beverages",
"category": "something else"
}
],
"unitAmount": 4.5,
"nameOverride": "",
"amountLessTax": 4.5,
"amountWithTax": 4.82,
"grossUnitAmount": 4.5,
"itemDescription": "Heinenken",
"discountedAmount": 0,
"accountingGroupId": "22187801051191",
"accountingGroupName": "Alcoholic beverages"
}
],
"accountProfileCode": "Reservation",
"accountProfileName": "Reservation",
"businessLocationId": "22187801052649",
"externalReferences": [
{
"prefix": "TASK",
"reference": "RN-22187801052649-test4#2ed4c054-53cf-4b03-90f8-58be424ee31"
}
],
"originAccountNumber": null,
"currentProductionPhase": 0
},
"sequenceId": "B35642.15",
"notificationType": "CLOSE",
"businessLocationId": 22187801052649,
"platformRestaurantId": "123451234",
"platformReservationId": "2ed4c054-53cf-4b03-90f8-58be424ee31"
}