v1

latestOpenAPI 3.1.02026-08-06911,228852.2 KB
Reservations for Platforms

Order notification

These notifications are sent to the URL provided in theorderWebhookUrl field.

postWebhookreservation-serviceReservation order notification

Payload

businessLocationIdinteger

The unique identifier of the business location.

notificationType'OPEN' | 'UPDATE' | 'CLOSE' | 'CANCEL'
platformRestaurantIdstring

The external platform's unique identifier for the restaurant.

sequenceIdstring
platformReservationIdstring

The external platform's unique identifier for the reservation.

platformCodestring

The unique code assigned to the reservation platform.

Example payload

{
  "account": {
    "accountNumber": "A833754.74",
    "accountObjectId": "25769805453",
    "accountProfileCode": "zoneB",
    "accountProfileId": "25769805764",
    "accountProfileName": "Livraison Zone B",
    "businessLocationId": "9765040300495493",
    "closeDate": 1694083785354,
    "consumerRecord": {
      "consumer": {
        "emailAddress": "napoleon@bonapart.fr",
        "id": "111466"
      },
      "consumerRecordUUID": "8649450c-5c10-4e63-8461-12bbf5a51cbc",
      "contactInformation": {
        "city": "Paris",
        "companyName": "Non",
        "firstName": "Alexandr",
        "fullName": "Alexandr Pushkin",
        "lastName": "Pushkin",
        "taxIdentifier": "23142342134"
      },
      "externalReferences": [
        {
          "key": "open-table-api-client",
          "reference": "OO.11.opentable-anonymous"
        }
      ],
      "id": "36577"
    },
    "coverCount": 2,
    "currencyCode": "EUR",
    "discounts": [
      {
        "code": "test_discount",
        "description": "test discount description",
        "id": "197568495841",
        "rate": 0.9
      }
    ],
    "externalReferences": [
      {
        "prefix": "TASK",
        "reference": "RN-197568495618-reservation_id_123213126"
      }
    ],
    "gratuityAmount": 20,
    "id": "21474836499",
    "latestExternalReferences": [
      {
        "prefix": "TASK",
        "reference": "RN-197568495618-reservation_id_123213126"
      }
    ],
    "name": "Floor 1, Table 2",
    "offset": 240,
    "orderMode": "ONLINE",
    "openDate": 1694083785354,
    "originAccountId": 21474836579,
    "originAccountNumber": "A1.5",
    "paidAmount": 45,
    "paymentLines": [
      {
        "accountId": "21474836499",
        "amount": 45,
        "currencyCode": "GBP",
        "date": 1694084890294,
        "gratuityAmount": 50,
        "id": 21474836506,
        "paymentMethod": "IKGIFT",
        "paymentMethodDescription": "Geschenkkarte"
      }
    ],
    "preTaxAmount": 201.78,
    "receiptNumber": "R1.2",
    "serviceCharge": 34.2,
    "staffId": "13",
    "staffName": "Manager",
    "tableName": "Table 112",
    "tableNumber": 112,
    "tables": [
      "112",
      "112A"
    ],
    "taxAmount": 14.12,
    "totalAmount": 30,
    "totalDiscount": 0.9,
    "transactionLines": [
      {
        "accountId": "502721627029505",
        "accountingGroupId": "77309411368",
        "accountingGroupName": "Misc",
        "activeTax": {
          "code": "TVA77",
          "description": "TVA 7.7%",
          "rate": 1.07,
          "taxIncluded": true
        },
        "amount": 0.45,
        "amountLessTax": 4.21,
        "amountWithTax": 4.5,
        "categories": [
          {
            "category": "default",
            "value": "Misc"
          }
        ],
        "date": 1694083815402,
        "discountedAmount": 0.05,
        "grossUnitAmount": 4.5,
        "id": "502721627029513",
        "itemDescription": "Dom Pérignon",
        "itemId": "77309411427",
        "itemSku": "6",
        "modifiers": [
          {
            "name": "Milch",
            "quantity": 1
          }
        ],
        "nameOverride": "Burger for our friend Ben",
        "quantity": 6,
        "tags": "Test tag 4",
        "unitAmount": 0.9
      }
    ],
    "type": "SALE",
    "updateDate": 1694083819623
  },
  "businessLocationId": 9765040300495492,
  "platformRestaurantId": "Restaurant-123",
  "platformReservationId": "Reservation-123",
  "platformCode": "MyPlatform"
}

Response

Your server returns this code if it accepts the callback.