EPOS Data API WS 1.0.0

Operations

• PUB RecordPaymentV1

  Accepts the following message:

  <anonymous-message-1>

  Payload

  object allOf

  uid: RecordPaymentJsonrpcResponseV1

  Consists of:

  object

  uid: JsonrpcResponseV1

  id

  required

  string

  error

  object

  uid: Error

  Additional properties are allowed.

  jsonrpc

  required

  string

  Additional properties are allowed.

  And with:

  object

  uid: PaymentResult

  result

  required

  object

  uid: Payment

  paymentIntentId

  required

  string

  paidAmount

  required

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  tipsAmount

  oneOf

  The tips amount.

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "error": {},
    "jsonrpc": "string",
    "result": {
      "paymentIntentId": "string",
      "paidAmount": {
        "value": 1000,
        "currencyCode": "GBP"
      },
      "tipsAmount": {
        "value": 1000,
        "currencyCode": "GBP"
      }
    }
  }
  

  This example has been generated automatically.

• SUB RecordPaymentV1

  Accepts the following message:

  <anonymous-message-2>

  Payload

  object allOf

  uid: RecordPaymentJsonrpcRequestV1

  Consists of:

  object

  uid: JsonrpcRequestV1

  id

  required

  string

  method

  required

  string

  jsonrpc

  required

  string

  Additional properties are allowed.

  And with:

  object

  uid: RecordPaymentParams

  params

  required

  object

  uid: OrderPayment

  orderId

  required

  string

  payment

  required

  object

  uid: Payment

  paymentIntentId

  required

  string

  paidAmount

  required

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  tipsAmount

  oneOf

  The tips amount.

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "method": "string",
    "jsonrpc": "string",
    "params": {
      "orderId": "string",
      "payment": {
        "paymentIntentId": "string",
        "paidAmount": {
          "value": 1000,
          "currencyCode": "GBP"
        },
        "tipsAmount": {
          "value": 1000,
          "currencyCode": "GBP"
        }
      }
    }
  }
  

  This example has been generated automatically.

• PUB SearchOrdersV1

  Accepts the following message:

  <anonymous-message-3>

  Payload

  object allOf

  uid: PagedOrdersJsonrpcResponseV1

  Consists of:

  object

  uid: JsonrpcResponseV1

  id

  required

  string

  error

  object

  uid: Error

  Additional properties are allowed.

  jsonrpc

  required

  string

  Additional properties are allowed.

  And with:

  object

  uid: PagedOrdersResult

  result

  required

  object

  uid: PagedOrdersResponse

  data

  required

  array<object>

  uid: Order

  id

  string

  Order ID

  items

  array<object>

  uid: OrderItem

  The line items purchased by the customer.

  amountPerItem

  required

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  quantity

  required

  integer

  note

  string

  name

  required

  string

  A human-readable name of the item.

  plu

  required

  string

  subItems

  array<object>

  uid: OrderSubItem

  Sub-items applied to the item

  amountPerItem

  required

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  quantity

  required

  integer

  note

  string

  name

  required

  string

  A human-readable name of the item.

  plu

  required

  string

  modifiers

  array<object>

  uid: Modifier

  Modifiers applied to the subitem

  name

  required

  string

  A human-readable name of the modifier.

  Response

  Const:

  ""

  quantity

  required

  integer

  How many times this modifier is applied to the item. Please note that this amount is per single item, so if a customer orders two burgers each with double extra cheese, the quantity should be 2, not 4.

  Response

  Const:

  ""

  amountPerModifier

  required

  oneOf

  Total amount to be paid for this modifier.

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  Response

  Const:

  ""

  plu

  required

  string

  modifiers

  array<object>

  uid: Modifier

  Modifiers applied to the item

  name

  required

  string

  A human-readable name of the modifier.

  Response

  Const:

  ""

  quantity

  required

  integer

  How many times this modifier is applied to the item. Please note that this amount is per single item, so if a customer orders two burgers each with double extra cheese, the quantity should be 2, not 4.

  Response

  Const:

  ""

  amountPerModifier

  required

  oneOf

  Total amount to be paid for this modifier.

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  Response

  Const:

  ""

  plu

  required

  string

  note

  string

  Response

  Const:

  ""

  customer

  object

  uid: Customer

  id

  string

  The unique identifier of the customer.

  emailAddress

  string

  <= 254 characters

  The customer's email address.

  phoneNumber

  string

  <= 50 characters

  The customer's phone number.

  name

  string

  The customer's name.

  Response

  Const:

  ""

  Additional properties are NOT allowed.

  discounts

  array<object>

  uid: Discount

  List of discounts applied to the order

  name

  required

  string

  The name that was given to the discount.

  affectedPlu

  string

  Product plu for which the discount is applied to. Empty if discount is for the total amount

  discountReference

  string

  Discount reference that uniquely identifies the discount

  code

  string

  Discount code

  amountTotal

  required

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  amountPercentage

  integer

  Percentage covered by the discount, which is stored with precision 2 (e.g., 25.1% ➜ 2510)

  Response

  Const:

  ""

  taxLines

  array<object>

  uid: TaxLine

  Taxes applied to the order

  id

  string

  <= 60 characters

  Unique identifier for the object.

  name

  string

  <= 100 characters

  A name of the tax.

  affectedPlu

  string

  Plu of a product, if it is product specific tax

  amountPercentage

  integer

  Tax percentage, which is stored with precision 2 (e.g., 25.1% ➜ 2510)

  amountTotal

  required

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  Response

  Const:

  ""

  status

  required

  string

  uid: OrderStatus

  • Allowed values:
  • "New"
  • "Submitted"
  • "Confirmed"
  • "Accepted"
  • "Preparing"
  • "Prepared"
  • "Ready"
  • "Finalized"
  • "Canceled"
  • "Failed"

  createdAt

  string

  format: date-time

  The creation date, in ISO 8601 UTC format.

  Response

  Const:

  ""

  updatedAt

  string

  format: date-time

  The timestamp of the update date, in ISO 8601 UTC format.

  Response

  Const:

  ""

  totalAmount

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  payments

  array<object>

  uid: Payment

  paymentIntentId

  required

  string

  paidAmount

  required

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  tipsAmount

  oneOf

  The tips amount.

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  payable

  boolean

  Flag to indicate if the order is able to be paid for.

  paidAmount

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  serviceChargeAmount

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  reference

  string

  A unique identifier for the order. For example, Order 236.

  tipsAmount

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  details

  required

  object anyOf

  uid: OrderDetails

  Details about the order including the type and the details.

  dineIn

  object

  uid: DineInDetails

  Details for an order-in order

  tableId

  string

  waiterId

  string

  partyId

  string

  reservationId

  string

  readyAt

  string

  format: date-time

  Specify timestamp in ISO8601 UTC standard when a pre-order should be ready. Only applicable for pre-orders.

  Response

  Const:

  ""

  Additional properties are allowed.

  collection

  object

  uid: CollectionDetails

  asap

  boolean

  A boolean indicating whether order collection is as soon as possible

  collectAt

  string

  format: date-time

  Order collection timestamp in ISO8601 UTC standard. Only applicable when asap is not set or false

  Additional properties are allowed.

  orderType

  required

  string

  uid: OrderType

  • Allowed values:
  • "DineIn"
  • "Collection"

  Can adhere to:

  restricted any

  Or to:

  restricted any

  Additional properties are allowed.

  Response

  Const:

  ""

  before

  string

  Response

  Const:

  ""

  after

  string

  Response

  Const:

  ""

  Response

  Const:

  ""

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "error": {},
    "jsonrpc": "string",
    "result": {
      "data": [
        {
          "id": "string",
          "items": [
            {
              "amountPerItem": {
                "value": 1000,
                "currencyCode": "GBP"
              },
              "quantity": 0,
              "note": "string",
              "name": "string",
              "plu": "string",
              "subItems": [
                {
                  "amountPerItem": {
                    "value": 1000,
                    "currencyCode": "GBP"
                  },
                  "quantity": 0,
                  "note": "string",
                  "name": "string",
                  "plu": "string",
                  "modifiers": [
                    {
                      "name": "string",
                      "quantity": 0,
                      "amountPerModifier": {
                        "value": 1000,
                        "currencyCode": "GBP"
                      },
                      "plu": "string"
                    }
                  ]
                }
              ],
              "modifiers": [
                {
                  "name": "string",
                  "quantity": 0,
                  "amountPerModifier": {
                    "value": 1000,
                    "currencyCode": "GBP"
                  },
                  "plu": "string"
                }
              ]
            }
          ],
          "note": "string",
          "customer": {
            "emailAddress": "support@dojo.com",
            "phoneNumber": 448000443550
          },
          "discounts": [
            {
              "isPercentage": true,
              "provider": "Order & Pay app",
              "name": "Spring Sale 25% off",
              "discountCode": "SPRING2023",
              "discountReference": "123456",
              "affectedPlu": "item_123",
              "value": 2500,
              "amount": 500
            }
          ],
          "taxLines": [
            {
              "id": "string",
              "name": "string",
              "affectedPlu": "string",
              "amountPercentage": 0,
              "amountTotal": {
                "value": 1000,
                "currencyCode": "GBP"
              }
            }
          ],
          "status": "New",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "totalAmount": {
            "value": 1000,
            "currencyCode": "GBP"
          },
          "payments": [
            {
              "paymentIntentId": "string",
              "paidAmount": {
                "value": 1000,
                "currencyCode": "GBP"
              },
              "tipsAmount": {
                "value": 1000,
                "currencyCode": "GBP"
              }
            }
          ],
          "payable": true,
          "paidAmount": {
            "value": 1000,
            "currencyCode": "GBP"
          },
          "serviceChargeAmount": {
            "value": 1000,
            "currencyCode": "GBP"
          },
          "reference": "string",
          "tipsAmount": {
            "value": 1000,
            "currencyCode": "GBP"
          },
          "details": {}
        }
      ],
      "before": "string",
      "after": "string"
    }
  }
  

  This example has been generated automatically.

• SUB SearchOrdersV1

  Accepts the following message:

  <anonymous-message-4>

  Payload

  object allOf

  uid: SearchOrdersJsonrpcRequestV1

  Consists of:

  object

  uid: JsonrpcRequestV1

  id

  required

  string

  method

  required

  string

  jsonrpc

  required

  string

  Additional properties are allowed.

  And with:

  object

  uid: SearchOrdersParams

  params

  required

  object

  uid: SearchOrdersRequest

  dineIn

  object

  uid: DineInDetails

  Details for an order-in order

  tableId

  string

  waiterId

  string

  partyId

  string

  reservationId

  string

  readyAt

  string

  format: date-time

  Specify timestamp in ISO8601 UTC standard when a pre-order should be ready. Only applicable for pre-orders.

  Response

  Const:

  ""

  Additional properties are allowed.

  payableOnly

  boolean

  Return only orders where payable=true

  cursor

  object

  uid: Cursor

  A cursor for use in pagination.

  limit

  integer

  <= 100

  The maximum number of results to be returned in a single page.

  Response

  Const:

  ""

  before

  string

  A cursor for use in pagination for the previous page. before and after are mutually exclusive. Only one of these may be used.

  Response

  Const:

  ""

  after

  string

  A cursor for use in pagination for the next page. before and after are mutually exclusive. Only one of these may be used.

  Response

  Const:

  ""

  Response

  Const:

  ""

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "method": "string",
    "jsonrpc": "string",
    "params": {
      "dineIn": {
        "tableId": "string",
        "waiterId": "string",
        "partyId": "string",
        "reservationId": "string",
        "readyAt": "2019-08-24T14:15:22Z"
      },
      "payableOnly": true,
      "cursor": {
        "limit": 100,
        "before": "string",
        "after": "string"
      }
    }
  }
  

  This example has been generated automatically.

• PUB GetOrderByIdV1

  Accepts the following message:

  <anonymous-message-5>

  Payload

  object allOf

  uid: OrderJsonrpcResponseV1

  Consists of:

  object

  uid: JsonrpcResponseV1

  id

  required

  string

  error

  object

  uid: Error

  Additional properties are allowed.

  jsonrpc

  required

  string

  Additional properties are allowed.

  And with:

  object

  uid: OrderResult

  result

  required

  object

  uid: Order

  id

  string

  Order ID

  items

  array<object>

  uid: OrderItem

  The line items purchased by the customer.

  amountPerItem

  required

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  quantity

  required

  integer

  note

  string

  name

  required

  string

  A human-readable name of the item.

  plu

  required

  string

  subItems

  array<object>

  uid: OrderSubItem

  Sub-items applied to the item

  amountPerItem

  required

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  quantity

  required

  integer

  note

  string

  name

  required

  string

  A human-readable name of the item.

  plu

  required

  string

  modifiers

  array<object>

  uid: Modifier

  Modifiers applied to the subitem

  name

  required

  string

  A human-readable name of the modifier.

  Response

  Const:

  ""

  quantity

  required

  integer

  How many times this modifier is applied to the item. Please note that this amount is per single item, so if a customer orders two burgers each with double extra cheese, the quantity should be 2, not 4.

  Response

  Const:

  ""

  amountPerModifier

  required

  oneOf

  Total amount to be paid for this modifier.

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  Response

  Const:

  ""

  plu

  required

  string

  modifiers

  array<object>

  uid: Modifier

  Modifiers applied to the item

  name

  required

  string

  A human-readable name of the modifier.

  Response

  Const:

  ""

  quantity

  required

  integer

  How many times this modifier is applied to the item. Please note that this amount is per single item, so if a customer orders two burgers each with double extra cheese, the quantity should be 2, not 4.

  Response

  Const:

  ""

  amountPerModifier

  required

  oneOf

  Total amount to be paid for this modifier.

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  Response

  Const:

  ""

  plu

  required

  string

  note

  string

  Response

  Const:

  ""

  customer

  object

  uid: Customer

  id

  string

  The unique identifier of the customer.

  emailAddress

  string

  <= 254 characters

  The customer's email address.

  phoneNumber

  string

  <= 50 characters

  The customer's phone number.

  name

  string

  The customer's name.

  Response

  Const:

  ""

  Additional properties are NOT allowed.

  discounts

  array<object>

  uid: Discount

  List of discounts applied to the order

  name

  required

  string

  The name that was given to the discount.

  affectedPlu

  string

  Product plu for which the discount is applied to. Empty if discount is for the total amount

  discountReference

  string

  Discount reference that uniquely identifies the discount

  code

  string

  Discount code

  amountTotal

  required

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  amountPercentage

  integer

  Percentage covered by the discount, which is stored with precision 2 (e.g., 25.1% ➜ 2510)

  Response

  Const:

  ""

  taxLines

  array<object>

  uid: TaxLine

  Taxes applied to the order

  id

  string

  <= 60 characters

  Unique identifier for the object.

  name

  string

  <= 100 characters

  A name of the tax.

  affectedPlu

  string

  Plu of a product, if it is product specific tax

  amountPercentage

  integer

  Tax percentage, which is stored with precision 2 (e.g., 25.1% ➜ 2510)

  amountTotal

  required

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  Response

  Const:

  ""

  status

  required

  string

  uid: OrderStatus

  • Allowed values:
  • "New"
  • "Submitted"
  • "Confirmed"
  • "Accepted"
  • "Preparing"
  • "Prepared"
  • "Ready"
  • "Finalized"
  • "Canceled"
  • "Failed"

  createdAt

  string

  format: date-time

  The creation date, in ISO 8601 UTC format.

  Response

  Const:

  ""

  updatedAt

  string

  format: date-time

  The timestamp of the update date, in ISO 8601 UTC format.

  Response

  Const:

  ""

  totalAmount

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  payments

  array<object>

  uid: Payment

  paymentIntentId

  required

  string

  paidAmount

  required

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  tipsAmount

  oneOf

  The tips amount.

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  payable

  boolean

  Flag to indicate if the order is able to be paid for.

  paidAmount

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  serviceChargeAmount

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  reference

  string

  A unique identifier for the order. For example, Order 236.

  tipsAmount

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  details

  required

  object anyOf

  uid: OrderDetails

  Details about the order including the type and the details.

  dineIn

  object

  uid: DineInDetails

  Details for an order-in order

  tableId

  string

  waiterId

  string

  partyId

  string

  reservationId

  string

  readyAt

  string

  format: date-time

  Specify timestamp in ISO8601 UTC standard when a pre-order should be ready. Only applicable for pre-orders.

  Response

  Const:

  ""

  Additional properties are allowed.

  collection

  object

  uid: CollectionDetails

  asap

  boolean

  A boolean indicating whether order collection is as soon as possible

  collectAt

  string

  format: date-time

  Order collection timestamp in ISO8601 UTC standard. Only applicable when asap is not set or false

  Additional properties are allowed.

  orderType

  required

  string

  uid: OrderType

  • Allowed values:
  • "DineIn"
  • "Collection"

  Can adhere to:

  restricted any

  Or to:

  restricted any

  Additional properties are allowed.

  Response

  Const:

  ""

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "error": {},
    "jsonrpc": "string",
    "result": {
      "id": "string",
      "items": [
        {
          "amountPerItem": {
            "value": 1000,
            "currencyCode": "GBP"
          },
          "quantity": 0,
          "note": "string",
          "name": "string",
          "plu": "string",
          "subItems": [
            {
              "amountPerItem": {
                "value": 1000,
                "currencyCode": "GBP"
              },
              "quantity": 0,
              "note": "string",
              "name": "string",
              "plu": "string",
              "modifiers": [
                {
                  "name": "string",
                  "quantity": 0,
                  "amountPerModifier": {
                    "value": 1000,
                    "currencyCode": "GBP"
                  },
                  "plu": "string"
                }
              ]
            }
          ],
          "modifiers": [
            {
              "name": "string",
              "quantity": 0,
              "amountPerModifier": {
                "value": 1000,
                "currencyCode": "GBP"
              },
              "plu": "string"
            }
          ]
        }
      ],
      "note": "string",
      "customer": {
        "emailAddress": "support@dojo.com",
        "phoneNumber": 448000443550
      },
      "discounts": [
        {
          "isPercentage": true,
          "provider": "Order & Pay app",
          "name": "Spring Sale 25% off",
          "discountCode": "SPRING2023",
          "discountReference": "123456",
          "affectedPlu": "item_123",
          "value": 2500,
          "amount": 500
        }
      ],
      "taxLines": [
        {
          "id": "string",
          "name": "string",
          "affectedPlu": "string",
          "amountPercentage": 0,
          "amountTotal": {
            "value": 1000,
            "currencyCode": "GBP"
          }
        }
      ],
      "status": "New",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "totalAmount": {
        "value": 1000,
        "currencyCode": "GBP"
      },
      "payments": [
        {
          "paymentIntentId": "string",
          "paidAmount": {
            "value": 1000,
            "currencyCode": "GBP"
          },
          "tipsAmount": {
            "value": 1000,
            "currencyCode": "GBP"
          }
        }
      ],
      "payable": true,
      "paidAmount": {
        "value": 1000,
        "currencyCode": "GBP"
      },
      "serviceChargeAmount": {
        "value": 1000,
        "currencyCode": "GBP"
      },
      "reference": "string",
      "tipsAmount": {
        "value": 1000,
        "currencyCode": "GBP"
      },
      "details": {}
    }
  }
  

  This example has been generated automatically.

• SUB GetOrderByIdV1

  Accepts the following message:

  <anonymous-message-6>

  Payload

  object allOf

  uid: GetOrderByIdJsonrpcRequestV1

  Consists of:

  object

  uid: JsonrpcRequestV1

  id

  required

  string

  method

  required

  string

  jsonrpc

  required

  string

  Additional properties are allowed.

  And with:

  object

  uid: OrderIdParams

  params

  required

  object

  uid: OrderId

  orderId

  required

  string

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "method": "string",
    "jsonrpc": "string",
    "params": {
      "orderId": "string"
    }
  }
  

  This example has been generated automatically.

• PUB CancelOrderByIdV1

  Accepts the following message:

  <anonymous-message-7>

  Payload

  object allOf

  uid: OrderJsonrpcResponseV1

  Consists of:

  object

  uid: JsonrpcResponseV1

  id

  required

  string

  error

  object

  uid: Error

  Additional properties are allowed.

  jsonrpc

  required

  string

  Additional properties are allowed.

  And with:

  object

  uid: OrderResult

  result

  required

  object

  uid: Order

  id

  string

  Order ID

  items

  array<object>

  uid: OrderItem

  The line items purchased by the customer.

  amountPerItem

  required

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  quantity

  required

  integer

  note

  string

  name

  required

  string

  A human-readable name of the item.

  plu

  required

  string

  subItems

  array<object>

  uid: OrderSubItem

  Sub-items applied to the item

  amountPerItem

  required

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  quantity

  required

  integer

  note

  string

  name

  required

  string

  A human-readable name of the item.

  plu

  required

  string

  modifiers

  array<object>

  uid: Modifier

  Modifiers applied to the subitem

  name

  required

  string

  A human-readable name of the modifier.

  Response

  Const:

  ""

  quantity

  required

  integer

  How many times this modifier is applied to the item. Please note that this amount is per single item, so if a customer orders two burgers each with double extra cheese, the quantity should be 2, not 4.

  Response

  Const:

  ""

  amountPerModifier

  required

  oneOf

  Total amount to be paid for this modifier.

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  Response

  Const:

  ""

  plu

  required

  string

  modifiers

  array<object>

  uid: Modifier

  Modifiers applied to the item

  name

  required

  string

  A human-readable name of the modifier.

  Response

  Const:

  ""

  quantity

  required

  integer

  How many times this modifier is applied to the item. Please note that this amount is per single item, so if a customer orders two burgers each with double extra cheese, the quantity should be 2, not 4.

  Response

  Const:

  ""

  amountPerModifier

  required

  oneOf

  Total amount to be paid for this modifier.

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  Response

  Const:

  ""

  plu

  required

  string

  note

  string

  Response

  Const:

  ""

  customer

  object

  uid: Customer

  id

  string

  The unique identifier of the customer.

  emailAddress

  string

  <= 254 characters

  The customer's email address.

  phoneNumber

  string

  <= 50 characters

  The customer's phone number.

  name

  string

  The customer's name.

  Response

  Const:

  ""

  Additional properties are NOT allowed.

  discounts

  array<object>

  uid: Discount

  List of discounts applied to the order

  name

  required

  string

  The name that was given to the discount.

  affectedPlu

  string

  Product plu for which the discount is applied to. Empty if discount is for the total amount

  discountReference

  string

  Discount reference that uniquely identifies the discount

  code

  string

  Discount code

  amountTotal

  required

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  amountPercentage

  integer

  Percentage covered by the discount, which is stored with precision 2 (e.g., 25.1% ➜ 2510)

  Response

  Const:

  ""

  taxLines

  array<object>

  uid: TaxLine

  Taxes applied to the order

  id

  string

  <= 60 characters

  Unique identifier for the object.

  name

  string

  <= 100 characters

  A name of the tax.

  affectedPlu

  string

  Plu of a product, if it is product specific tax

  amountPercentage

  integer

  Tax percentage, which is stored with precision 2 (e.g., 25.1% ➜ 2510)

  amountTotal

  required

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  Response

  Const:

  ""

  status

  required

  string

  uid: OrderStatus

  • Allowed values:
  • "New"
  • "Submitted"
  • "Confirmed"
  • "Accepted"
  • "Preparing"
  • "Prepared"
  • "Ready"
  • "Finalized"
  • "Canceled"
  • "Failed"

  createdAt

  string

  format: date-time

  The creation date, in ISO 8601 UTC format.

  Response

  Const:

  ""

  updatedAt

  string

  format: date-time

  The timestamp of the update date, in ISO 8601 UTC format.

  Response

  Const:

  ""

  totalAmount

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  payments

  array<object>

  uid: Payment

  paymentIntentId

  required

  string

  paidAmount

  required

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  tipsAmount

  oneOf

  The tips amount.

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  payable

  boolean

  Flag to indicate if the order is able to be paid for.

  paidAmount

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  serviceChargeAmount

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  reference

  string

  A unique identifier for the order. For example, Order 236.

  tipsAmount

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  details

  required

  object anyOf

  uid: OrderDetails

  Details about the order including the type and the details.

  dineIn

  object

  uid: DineInDetails

  Details for an order-in order

  tableId

  string

  waiterId

  string

  partyId

  string

  reservationId

  string

  readyAt

  string

  format: date-time

  Specify timestamp in ISO8601 UTC standard when a pre-order should be ready. Only applicable for pre-orders.

  Response

  Const:

  ""

  Additional properties are allowed.

  collection

  object

  uid: CollectionDetails

  asap

  boolean

  A boolean indicating whether order collection is as soon as possible

  collectAt

  string

  format: date-time

  Order collection timestamp in ISO8601 UTC standard. Only applicable when asap is not set or false

  Additional properties are allowed.

  orderType

  required

  string

  uid: OrderType

  • Allowed values:
  • "DineIn"
  • "Collection"

  Can adhere to:

  restricted any

  Or to:

  restricted any

  Additional properties are allowed.

  Response

  Const:

  ""

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "error": {},
    "jsonrpc": "string",
    "result": {
      "id": "string",
      "items": [
        {
          "amountPerItem": {
            "value": 1000,
            "currencyCode": "GBP"
          },
          "quantity": 0,
          "note": "string",
          "name": "string",
          "plu": "string",
          "subItems": [
            {
              "amountPerItem": {
                "value": 1000,
                "currencyCode": "GBP"
              },
              "quantity": 0,
              "note": "string",
              "name": "string",
              "plu": "string",
              "modifiers": [
                {
                  "name": "string",
                  "quantity": 0,
                  "amountPerModifier": {
                    "value": 1000,
                    "currencyCode": "GBP"
                  },
                  "plu": "string"
                }
              ]
            }
          ],
          "modifiers": [
            {
              "name": "string",
              "quantity": 0,
              "amountPerModifier": {
                "value": 1000,
                "currencyCode": "GBP"
              },
              "plu": "string"
            }
          ]
        }
      ],
      "note": "string",
      "customer": {
        "emailAddress": "support@dojo.com",
        "phoneNumber": 448000443550
      },
      "discounts": [
        {
          "isPercentage": true,
          "provider": "Order & Pay app",
          "name": "Spring Sale 25% off",
          "discountCode": "SPRING2023",
          "discountReference": "123456",
          "affectedPlu": "item_123",
          "value": 2500,
          "amount": 500
        }
      ],
      "taxLines": [
        {
          "id": "string",
          "name": "string",
          "affectedPlu": "string",
          "amountPercentage": 0,
          "amountTotal": {
            "value": 1000,
            "currencyCode": "GBP"
          }
        }
      ],
      "status": "New",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "totalAmount": {
        "value": 1000,
        "currencyCode": "GBP"
      },
      "payments": [
        {
          "paymentIntentId": "string",
          "paidAmount": {
            "value": 1000,
            "currencyCode": "GBP"
          },
          "tipsAmount": {
            "value": 1000,
            "currencyCode": "GBP"
          }
        }
      ],
      "payable": true,
      "paidAmount": {
        "value": 1000,
        "currencyCode": "GBP"
      },
      "serviceChargeAmount": {
        "value": 1000,
        "currencyCode": "GBP"
      },
      "reference": "string",
      "tipsAmount": {
        "value": 1000,
        "currencyCode": "GBP"
      },
      "details": {}
    }
  }
  

  This example has been generated automatically.

• SUB CancelOrderByIdV1

  Accepts the following message:

  <anonymous-message-8>

  Payload

  object allOf

  uid: CancelOrderByIdJsonrpcRequestV1

  Consists of:

  object

  uid: JsonrpcRequestV1

  id

  required

  string

  method

  required

  string

  jsonrpc

  required

  string

  Additional properties are allowed.

  And with:

  object

  uid: OrderIdParams

  params

  required

  object

  uid: OrderId

  orderId

  required

  string

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "method": "string",
    "jsonrpc": "string",
    "params": {
      "orderId": "string"
    }
  }
  

  This example has been generated automatically.

• PUB CreateOrderV1

  Accepts the following message:

  <anonymous-message-9>

  Payload

  object allOf

  uid: OrderJsonrpcResponseV1

  Consists of:

  object

  uid: JsonrpcResponseV1

  id

  required

  string

  error

  object

  uid: Error

  Additional properties are allowed.

  jsonrpc

  required

  string

  Additional properties are allowed.

  And with:

  object

  uid: OrderResult

  result

  required

  object

  uid: Order

  id

  string

  Order ID

  items

  array<object>

  uid: OrderItem

  The line items purchased by the customer.

  amountPerItem

  required

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  quantity

  required

  integer

  note

  string

  name

  required

  string

  A human-readable name of the item.

  plu

  required

  string

  subItems

  array<object>

  uid: OrderSubItem

  Sub-items applied to the item

  amountPerItem

  required

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  quantity

  required

  integer

  note

  string

  name

  required

  string

  A human-readable name of the item.

  plu

  required

  string

  modifiers

  array<object>

  uid: Modifier

  Modifiers applied to the subitem

  name

  required

  string

  A human-readable name of the modifier.

  Response

  Const:

  ""

  quantity

  required

  integer

  How many times this modifier is applied to the item. Please note that this amount is per single item, so if a customer orders two burgers each with double extra cheese, the quantity should be 2, not 4.

  Response

  Const:

  ""

  amountPerModifier

  required

  oneOf

  Total amount to be paid for this modifier.

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  Response

  Const:

  ""

  plu

  required

  string

  modifiers

  array<object>

  uid: Modifier

  Modifiers applied to the item

  name

  required

  string

  A human-readable name of the modifier.

  Response

  Const:

  ""

  quantity

  required

  integer

  How many times this modifier is applied to the item. Please note that this amount is per single item, so if a customer orders two burgers each with double extra cheese, the quantity should be 2, not 4.

  Response

  Const:

  ""

  amountPerModifier

  required

  oneOf

  Total amount to be paid for this modifier.

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  Response

  Const:

  ""

  plu

  required

  string

  note

  string

  Response

  Const:

  ""

  customer

  object

  uid: Customer

  id

  string

  The unique identifier of the customer.

  emailAddress

  string

  <= 254 characters

  The customer's email address.

  phoneNumber

  string

  <= 50 characters

  The customer's phone number.

  name

  string

  The customer's name.

  Response

  Const:

  ""

  Additional properties are NOT allowed.

  discounts

  array<object>

  uid: Discount

  List of discounts applied to the order

  name

  required

  string

  The name that was given to the discount.

  affectedPlu

  string

  Product plu for which the discount is applied to. Empty if discount is for the total amount

  discountReference

  string

  Discount reference that uniquely identifies the discount

  code

  string

  Discount code

  amountTotal

  required

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  amountPercentage

  integer

  Percentage covered by the discount, which is stored with precision 2 (e.g., 25.1% ➜ 2510)

  Response

  Const:

  ""

  taxLines

  array<object>

  uid: TaxLine

  Taxes applied to the order

  id

  string

  <= 60 characters

  Unique identifier for the object.

  name

  string

  <= 100 characters

  A name of the tax.

  affectedPlu

  string

  Plu of a product, if it is product specific tax

  amountPercentage

  integer

  Tax percentage, which is stored with precision 2 (e.g., 25.1% ➜ 2510)

  amountTotal

  required

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  Response

  Const:

  ""

  status

  required

  string

  uid: OrderStatus

  • Allowed values:
  • "New"
  • "Submitted"
  • "Confirmed"
  • "Accepted"
  • "Preparing"
  • "Prepared"
  • "Ready"
  • "Finalized"
  • "Canceled"
  • "Failed"

  createdAt

  string

  format: date-time

  The creation date, in ISO 8601 UTC format.

  Response

  Const:

  ""

  updatedAt

  string

  format: date-time

  The timestamp of the update date, in ISO 8601 UTC format.

  Response

  Const:

  ""

  totalAmount

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  payments

  array<object>

  uid: Payment

  paymentIntentId

  required

  string

  paidAmount

  required

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  tipsAmount

  oneOf

  The tips amount.

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  payable

  boolean

  Flag to indicate if the order is able to be paid for.

  paidAmount

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  serviceChargeAmount

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  reference

  string

  A unique identifier for the order. For example, Order 236.

  tipsAmount

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  details

  required

  object anyOf

  uid: OrderDetails

  Details about the order including the type and the details.

  dineIn

  object

  uid: DineInDetails

  Details for an order-in order

  tableId

  string

  waiterId

  string

  partyId

  string

  reservationId

  string

  readyAt

  string

  format: date-time

  Specify timestamp in ISO8601 UTC standard when a pre-order should be ready. Only applicable for pre-orders.

  Response

  Const:

  ""

  Additional properties are allowed.

  collection

  object

  uid: CollectionDetails

  asap

  boolean

  A boolean indicating whether order collection is as soon as possible

  collectAt

  string

  format: date-time

  Order collection timestamp in ISO8601 UTC standard. Only applicable when asap is not set or false

  Additional properties are allowed.

  orderType

  required

  string

  uid: OrderType

  • Allowed values:
  • "DineIn"
  • "Collection"

  Can adhere to:

  restricted any

  Or to:

  restricted any

  Additional properties are allowed.

  Response

  Const:

  ""

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "error": {},
    "jsonrpc": "string",
    "result": {
      "id": "string",
      "items": [
        {
          "amountPerItem": {
            "value": 1000,
            "currencyCode": "GBP"
          },
          "quantity": 0,
          "note": "string",
          "name": "string",
          "plu": "string",
          "subItems": [
            {
              "amountPerItem": {
                "value": 1000,
                "currencyCode": "GBP"
              },
              "quantity": 0,
              "note": "string",
              "name": "string",
              "plu": "string",
              "modifiers": [
                {
                  "name": "string",
                  "quantity": 0,
                  "amountPerModifier": {
                    "value": 1000,
                    "currencyCode": "GBP"
                  },
                  "plu": "string"
                }
              ]
            }
          ],
          "modifiers": [
            {
              "name": "string",
              "quantity": 0,
              "amountPerModifier": {
                "value": 1000,
                "currencyCode": "GBP"
              },
              "plu": "string"
            }
          ]
        }
      ],
      "note": "string",
      "customer": {
        "emailAddress": "support@dojo.com",
        "phoneNumber": 448000443550
      },
      "discounts": [
        {
          "isPercentage": true,
          "provider": "Order & Pay app",
          "name": "Spring Sale 25% off",
          "discountCode": "SPRING2023",
          "discountReference": "123456",
          "affectedPlu": "item_123",
          "value": 2500,
          "amount": 500
        }
      ],
      "taxLines": [
        {
          "id": "string",
          "name": "string",
          "affectedPlu": "string",
          "amountPercentage": 0,
          "amountTotal": {
            "value": 1000,
            "currencyCode": "GBP"
          }
        }
      ],
      "status": "New",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "totalAmount": {
        "value": 1000,
        "currencyCode": "GBP"
      },
      "payments": [
        {
          "paymentIntentId": "string",
          "paidAmount": {
            "value": 1000,
            "currencyCode": "GBP"
          },
          "tipsAmount": {
            "value": 1000,
            "currencyCode": "GBP"
          }
        }
      ],
      "payable": true,
      "paidAmount": {
        "value": 1000,
        "currencyCode": "GBP"
      },
      "serviceChargeAmount": {
        "value": 1000,
        "currencyCode": "GBP"
      },
      "reference": "string",
      "tipsAmount": {
        "value": 1000,
        "currencyCode": "GBP"
      },
      "details": {}
    }
  }
  

  This example has been generated automatically.

• SUB CreateOrderV1

  Accepts the following message:

  <anonymous-message-10>

  Payload

  object allOf

  uid: CreateOrderJsonrpcRequestV1

  Consists of:

  object

  uid: JsonrpcRequestV1

  id

  required

  string

  method

  required

  string

  jsonrpc

  required

  string

  Additional properties are allowed.

  And with:

  object

  uid: CreateOrderParams

  params

  required

  object

  uid: CreateOrderRequest

  items

  required

  array<object>

  uid: OrderItem

  The line items purchased by the customer.

  amountPerItem

  required

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  quantity

  required

  integer

  note

  string

  name

  required

  string

  A human-readable name of the item.

  plu

  required

  string

  subItems

  array<object>

  uid: OrderSubItem

  Sub-items applied to the item

  amountPerItem

  required

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  quantity

  required

  integer

  note

  string

  name

  required

  string

  A human-readable name of the item.

  plu

  required

  string

  modifiers

  array<object>

  uid: Modifier

  Modifiers applied to the subitem

  name

  required

  string

  A human-readable name of the modifier.

  Response

  Const:

  ""

  quantity

  required

  integer

  How many times this modifier is applied to the item. Please note that this amount is per single item, so if a customer orders two burgers each with double extra cheese, the quantity should be 2, not 4.

  Response

  Const:

  ""

  amountPerModifier

  required

  oneOf

  Total amount to be paid for this modifier.

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  Response

  Const:

  ""

  plu

  required

  string

  modifiers

  array<object>

  uid: Modifier

  Modifiers applied to the item

  name

  required

  string

  A human-readable name of the modifier.

  Response

  Const:

  ""

  quantity

  required

  integer

  How many times this modifier is applied to the item. Please note that this amount is per single item, so if a customer orders two burgers each with double extra cheese, the quantity should be 2, not 4.

  Response

  Const:

  ""

  amountPerModifier

  required

  oneOf

  Total amount to be paid for this modifier.

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  Response

  Const:

  ""

  plu

  required

  string

  note

  string

  Order note

  customer

  object

  uid: Customer

  id

  string

  The unique identifier of the customer.

  emailAddress

  string

  <= 254 characters

  The customer's email address.

  phoneNumber

  string

  <= 50 characters

  The customer's phone number.

  name

  string

  The customer's name.

  Response

  Const:

  ""

  Additional properties are NOT allowed.

  discounts

  array<object>

  uid: Discount

  List of discounts applied to the order

  name

  required

  string

  The name that was given to the discount.

  affectedPlu

  string

  Product plu for which the discount is applied to. Empty if discount is for the total amount

  discountReference

  string

  Discount reference that uniquely identifies the discount

  code

  string

  Discount code

  amountTotal

  required

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  amountPercentage

  integer

  Percentage covered by the discount, which is stored with precision 2 (e.g., 25.1% ➜ 2510)

  Response

  Const:

  ""

  totalAmount

  required

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  taxLines

  array<object>

  uid: TaxLine

  Taxes applied to the order

  id

  string

  <= 60 characters

  Unique identifier for the object.

  name

  string

  <= 100 characters

  A name of the tax.

  affectedPlu

  string

  Plu of a product, if it is product specific tax

  amountPercentage

  integer

  Tax percentage, which is stored with precision 2 (e.g., 25.1% ➜ 2510)

  amountTotal

  required

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  serviceChargeAmount

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  reference

  string

  A unique identifier for the order. For example, Order 236.

  dojoOrderId

  required

  string

  The Dojo API order ID

  payments

  required

  array<object>

  uid: Payment

  paymentIntentId

  required

  string

  paidAmount

  required

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  tipsAmount

  oneOf

  The tips amount.

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  details

  required

  object anyOf

  uid: OrderDetails

  Details about the order including the type and the details.

  dineIn

  object

  uid: DineInDetails

  Details for an order-in order

  tableId

  string

  waiterId

  string

  partyId

  string

  reservationId

  string

  readyAt

  string

  format: date-time

  Specify timestamp in ISO8601 UTC standard when a pre-order should be ready. Only applicable for pre-orders.

  Response

  Const:

  ""

  Additional properties are allowed.

  collection

  object

  uid: CollectionDetails

  asap

  boolean

  A boolean indicating whether order collection is as soon as possible

  collectAt

  string

  format: date-time

  Order collection timestamp in ISO8601 UTC standard. Only applicable when asap is not set or false

  Additional properties are allowed.

  orderType

  required

  string

  uid: OrderType

  • Allowed values:
  • "DineIn"
  • "Collection"

  Can adhere to:

  restricted any

  Or to:

  restricted any

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "method": "string",
    "jsonrpc": "string",
    "params": {
      "items": [
        {
          "amountPerItem": {
            "value": 1000,
            "currencyCode": "GBP"
          },
          "quantity": 0,
          "note": "string",
          "name": "string",
          "plu": "string",
          "subItems": [
            {
              "amountPerItem": {
                "value": 1000,
                "currencyCode": "GBP"
              },
              "quantity": 0,
              "note": "string",
              "name": "string",
              "plu": "string",
              "modifiers": [
                {
                  "name": "string",
                  "quantity": 0,
                  "amountPerModifier": {
                    "value": 1000,
                    "currencyCode": "GBP"
                  },
                  "plu": "string"
                }
              ]
            }
          ],
          "modifiers": [
            {
              "name": "string",
              "quantity": 0,
              "amountPerModifier": {
                "value": 1000,
                "currencyCode": "GBP"
              },
              "plu": "string"
            }
          ]
        }
      ],
      "note": "string",
      "customer": {
        "emailAddress": "support@dojo.com",
        "phoneNumber": 448000443550
      },
      "discounts": [
        {
          "isPercentage": true,
          "provider": "Order & Pay app",
          "name": "Spring Sale 25% off",
          "discountCode": "SPRING2023",
          "discountReference": "123456",
          "affectedPlu": "item_123",
          "value": 2500,
          "amount": 500
        }
      ],
      "totalAmount": {
        "value": 1000,
        "currencyCode": "GBP"
      },
      "taxLines": [
        {
          "id": "string",
          "name": "string",
          "affectedPlu": "string",
          "amountPercentage": 0,
          "amountTotal": {
            "value": 1000,
            "currencyCode": "GBP"
          }
        }
      ],
      "serviceChargeAmount": {
        "value": 1000,
        "currencyCode": "GBP"
      },
      "reference": "string",
      "dojoOrderId": "string",
      "payments": [
        {
          "paymentIntentId": "string",
          "paidAmount": {
            "value": 1000,
            "currencyCode": "GBP"
          },
          "tipsAmount": {
            "value": 1000,
            "currencyCode": "GBP"
          }
        }
      ],
      "details": {}
    }
  }
  

  This example has been generated automatically.

• PUB ListAreasV1

  Accepts the following message:

  <anonymous-message-11>

  Payload

  object allOf

  uid: ListAreasJsonrpcResponseV1

  Consists of:

  object

  uid: JsonrpcResponseV1

  id

  required

  string

  error

  object

  uid: Error

  Additional properties are allowed.

  jsonrpc

  required

  string

  Additional properties are allowed.

  And with:

  object

  uid: AreasResult

  result

  required

  array<object>

  uid: Area

  id

  required

  string

  Unique ID of the area

  name

  required

  string

  User friendly name of the area

  waiterIds

  array<string>

  Items:

  string

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "error": {},
    "jsonrpc": "string",
    "result": [
      {
        "id": "area_1234",
        "name": "downstairs"
      }
    ]
  }
  

  This example has been generated automatically.

• SUB ListAreasV1

  Accepts the following message:

  <anonymous-message-12>

  Payload

  object allOf

  uid: ListAreasJsonrpcRequestV1

  Consists of:

  object

  uid: JsonrpcRequestV1

  id

  required

  string

  method

  required

  string

  jsonrpc

  required

  string

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "method": "string",
    "jsonrpc": "string"
  }
  

  This example has been generated automatically.

• PUB CreatePartyV1

  Accepts the following message:

  <anonymous-message-13>

  Payload

  object allOf

  uid: PartyJsonrpcResponseV1

  Consists of:

  object

  uid: JsonrpcResponseV1

  id

  required

  string

  error

  object

  uid: Error

  Additional properties are allowed.

  jsonrpc

  required

  string

  Additional properties are allowed.

  And with:

  object

  uid: PartyResult

  result

  required

  object

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "error": {},
    "jsonrpc": "string",
    "result": {}
  }
  

  This example has been generated automatically.

• SUB CreatePartyV1

  Accepts the following message:

  <anonymous-message-14>

  Payload

  object allOf

  uid: CreatePartyJsonrpcRequestV1

  Consists of:

  object

  uid: JsonrpcRequestV1

  id

  required

  string

  method

  required

  string

  jsonrpc

  required

  string

  Additional properties are allowed.

  And with:

  object

  uid: CreateReservationParams

  params

  required

  object

  name

  required

  string

  covers

  required

  integer

  startTime

  required

  string

  format: date-time

  endTime

  required

  string

  format: date-time

  tableIds

  required

  array<string>

  non-empty

  Items:

  string

  hostNotes

  string

  guestRequests

  string

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "method": "string",
    "jsonrpc": "string",
    "params": {
      "name": "string",
      "covers": 0,
      "startTime": "2019-08-24T14:15:22Z",
      "endTime": "2019-08-24T14:15:22Z",
      "tableIds": [
        "string"
      ],
      "hostNotes": "string",
      "guestRequests": "string"
    }
  }
  

  This example has been generated automatically.

• PUB GetPartyByIdV1

  Accepts the following message:

  <anonymous-message-15>

  Payload

  object allOf

  uid: PartyJsonrpcResponseV1

  Consists of:

  object

  uid: JsonrpcResponseV1

  id

  required

  string

  error

  object

  uid: Error

  Additional properties are allowed.

  jsonrpc

  required

  string

  Additional properties are allowed.

  And with:

  object

  uid: PartyResult

  result

  required

  object

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "error": {},
    "jsonrpc": "string",
    "result": {}
  }
  

  This example has been generated automatically.

• SUB GetPartyByIdV1

  Accepts the following message:

  <anonymous-message-16>

  Payload

  object allOf

  uid: GetPartyByIdJsonrpcRequestV1

  Consists of:

  object

  uid: JsonrpcRequestV1

  id

  required

  string

  method

  required

  string

  jsonrpc

  required

  string

  Additional properties are allowed.

  And with:

  object

  uid: GetPartyByIdParams

  params

  required

  object

  partyId

  required

  string

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "method": "string",
    "jsonrpc": "string",
    "params": {
      "partyId": "string"
    }
  }
  

  This example has been generated automatically.

• PUB UpdatePartyV1

  Accepts the following message:

  <anonymous-message-17>

  Payload

  object allOf

  uid: PartyJsonrpcResponseV1

  Consists of:

  object

  uid: JsonrpcResponseV1

  id

  required

  string

  error

  object

  uid: Error

  Additional properties are allowed.

  jsonrpc

  required

  string

  Additional properties are allowed.

  And with:

  object

  uid: PartyResult

  result

  required

  object

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "error": {},
    "jsonrpc": "string",
    "result": {}
  }
  

  This example has been generated automatically.

• SUB UpdatePartyV1

  Accepts the following message:

  <anonymous-message-18>

  Payload

  object allOf

  uid: UpdatePartyJsonrpcRequestV1

  Consists of:

  object

  uid: JsonrpcRequestV1

  id

  required

  string

  method

  required

  string

  jsonrpc

  required

  string

  Additional properties are allowed.

  And with:

  object

  uid: UpdatePartyParams

  params

  required

  object

  party

  required

  object

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "method": "string",
    "jsonrpc": "string",
    "params": {
      "party": {}
    }
  }
  

  This example has been generated automatically.

• PUB CreateReservationV1

  Accepts the following message:

  <anonymous-message-19>

  Payload

  object allOf

  uid: ReservationJsonrpcResponseV1

  Consists of:

  object

  uid: JsonrpcResponseV1

  id

  required

  string

  error

  object

  uid: Error

  Additional properties are allowed.

  jsonrpc

  required

  string

  Additional properties are allowed.

  And with:

  object

  uid: ReservationResult

  result

  required

  object

  uid: Reservation

  A reservation describes a point in the future that a party is expected to be seated at, how long for, and where. For full documentation, see the synchronous API model.

  id

  required

  string

  name

  required

  string

  covers

  required

  integer

  startTime

  required

  string

  format: date-time

  When the reservation is expected to arrive. ISO8601 formatted, ms precise.

  endTime

  required

  string

  format: date-time

  When the reservation is expected to depart. ISO8601 formatted, ms precise.

  tableIds

  required

  array<string>

  non-empty

  Items:

  string

  hostNotes

  string

  guestRequests

  string

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "error": {},
    "jsonrpc": "string",
    "result": {
      "id": "string",
      "name": "string",
      "covers": 0,
      "startTime": "2019-08-24T14:15:22Z",
      "endTime": "2019-08-24T14:15:22Z",
      "tableIds": [
        "string"
      ],
      "hostNotes": "string",
      "guestRequests": "string"
    }
  }
  

  This example has been generated automatically.

• SUB CreateReservationV1

  Accepts the following message:

  <anonymous-message-20>

  Payload

  object allOf

  uid: CreateReservationJsonrpcRequestV1

  Consists of:

  object

  uid: JsonrpcRequestV1

  id

  required

  string

  method

  required

  string

  jsonrpc

  required

  string

  Additional properties are allowed.

  And with:

  object

  uid: CreateReservationParams

  params

  required

  object

  name

  required

  string

  covers

  required

  integer

  startTime

  required

  string

  format: date-time

  endTime

  required

  string

  format: date-time

  tableIds

  required

  array<string>

  non-empty

  Items:

  string

  hostNotes

  string

  guestRequests

  string

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "method": "string",
    "jsonrpc": "string",
    "params": {
      "name": "string",
      "covers": 0,
      "startTime": "2019-08-24T14:15:22Z",
      "endTime": "2019-08-24T14:15:22Z",
      "tableIds": [
        "string"
      ],
      "hostNotes": "string",
      "guestRequests": "string"
    }
  }
  

  This example has been generated automatically.

• PUB GetReservationByIdV1

  Accepts the following message:

  <anonymous-message-21>

  Payload

  object allOf

  uid: ReservationJsonrpcResponseV1

  Consists of:

  object

  uid: JsonrpcResponseV1

  id

  required

  string

  error

  object

  uid: Error

  Additional properties are allowed.

  jsonrpc

  required

  string

  Additional properties are allowed.

  And with:

  object

  uid: ReservationResult

  result

  required

  object

  uid: Reservation

  A reservation describes a point in the future that a party is expected to be seated at, how long for, and where. For full documentation, see the synchronous API model.

  id

  required

  string

  name

  required

  string

  covers

  required

  integer

  startTime

  required

  string

  format: date-time

  When the reservation is expected to arrive. ISO8601 formatted, ms precise.

  endTime

  required

  string

  format: date-time

  When the reservation is expected to depart. ISO8601 formatted, ms precise.

  tableIds

  required

  array<string>

  non-empty

  Items:

  string

  hostNotes

  string

  guestRequests

  string

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "error": {},
    "jsonrpc": "string",
    "result": {
      "id": "string",
      "name": "string",
      "covers": 0,
      "startTime": "2019-08-24T14:15:22Z",
      "endTime": "2019-08-24T14:15:22Z",
      "tableIds": [
        "string"
      ],
      "hostNotes": "string",
      "guestRequests": "string"
    }
  }
  

  This example has been generated automatically.

• SUB GetReservationByIdV1

  Accepts the following message:

  <anonymous-message-22>

  Payload

  object allOf

  uid: GetReservationByIdJsonrpcRequestV1

  Consists of:

  object

  uid: JsonrpcRequestV1

  id

  required

  string

  method

  required

  string

  jsonrpc

  required

  string

  Additional properties are allowed.

  And with:

  object

  uid: GetReservationByIdParams

  params

  required

  object

  reservationId

  required

  string

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "method": "string",
    "jsonrpc": "string",
    "params": {
      "reservationId": "string"
    }
  }
  

  This example has been generated automatically.

• PUB UpdateReservationV1

  Accepts the following message:

  <anonymous-message-23>

  Payload

  object allOf

  uid: ReservationJsonrpcResponseV1

  Consists of:

  object

  uid: JsonrpcResponseV1

  id

  required

  string

  error

  object

  uid: Error

  Additional properties are allowed.

  jsonrpc

  required

  string

  Additional properties are allowed.

  And with:

  object

  uid: ReservationResult

  result

  required

  object

  uid: Reservation

  A reservation describes a point in the future that a party is expected to be seated at, how long for, and where. For full documentation, see the synchronous API model.

  id

  required

  string

  name

  required

  string

  covers

  required

  integer

  startTime

  required

  string

  format: date-time

  When the reservation is expected to arrive. ISO8601 formatted, ms precise.

  endTime

  required

  string

  format: date-time

  When the reservation is expected to depart. ISO8601 formatted, ms precise.

  tableIds

  required

  array<string>

  non-empty

  Items:

  string

  hostNotes

  string

  guestRequests

  string

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "error": {},
    "jsonrpc": "string",
    "result": {
      "id": "string",
      "name": "string",
      "covers": 0,
      "startTime": "2019-08-24T14:15:22Z",
      "endTime": "2019-08-24T14:15:22Z",
      "tableIds": [
        "string"
      ],
      "hostNotes": "string",
      "guestRequests": "string"
    }
  }
  

  This example has been generated automatically.

• SUB UpdateReservationV1

  Accepts the following message:

  <anonymous-message-24>

  Payload

  object allOf

  uid: UpdateReservationJsonrpcRequestV1

  Consists of:

  object

  uid: JsonrpcRequestV1

  id

  required

  string

  method

  required

  string

  jsonrpc

  required

  string

  Additional properties are allowed.

  And with:

  object

  uid: UpdateReservationParams

  params

  required

  object

  reservation

  required

  object

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "method": "string",
    "jsonrpc": "string",
    "params": {
      "reservation": {}
    }
  }
  

  This example has been generated automatically.

• PUB SearchPartiesV1

  Accepts the following message:

  <anonymous-message-25>

  Payload

  object allOf

  uid: PagedPartiesJsonrpcResponseV1

  Consists of:

  object

  uid: JsonrpcResponseV1

  id

  required

  string

  error

  object

  uid: Error

  Additional properties are allowed.

  jsonrpc

  required

  string

  Additional properties are allowed.

  And with:

  object

  uid: PagedPartiesResult

  result

  required

  object

  uid: PagedPartiesResponse

  data

  required

  array<object>

  uid: Party

  id

  required

  string

  name

  string

  covers

  integer

  tableIds

  required

  array<string>

  non-empty

  Items:

  string

  status

  required

  string

  non-empty

  startTime

  required

  string

  format: date-time

  expectedEndTime

  string

  format: date-time

  endTime

  string

  format: date-time

  hostNotes

  string

  guestRequests

  string

  reservationId

  string

  deposit

  restricted any

  uid: PartyDeposit

  totalAmount

  required

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  payments

  array<object>

  uid: Payment

  paymentIntentId

  required

  string

  paidAmount

  required

  oneOf

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  tipsAmount

  oneOf

  The tips amount.

  Adheres to:

  object

  uid: Money

  value

  required

  integer

  format: int64

  The amount in the minor unit, for example '100' for 1.00 GBP.

  currencyCode

  required

  string

  [ 1 .. 10 ] characters

  Three-letter currency code in ISO 4217 alpha-3 format.

  Response

  Const:

  ""

  Additional properties are allowed.

  Response

  Const:

  ""

  before

  string

  Response

  Const:

  ""

  after

  string

  Response

  Const:

  ""

  Response

  Const:

  ""

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "error": {},
    "jsonrpc": "string",
    "result": {
      "data": [
        {
          "id": "string",
          "name": "string",
          "covers": 0,
          "tableIds": [
            "string"
          ],
          "status": "string",
          "startTime": "2019-08-24T14:15:22Z",
          "expectedEndTime": "2019-08-24T14:15:22Z",
          "endTime": "2019-08-24T14:15:22Z",
          "hostNotes": "string",
          "guestRequests": "string",
          "reservationId": "string",
          "deposit": {
            "totalAmount": {
              "value": 1000,
              "currencyCode": "GBP"
            },
            "payments": [
              {
                "paymentIntentId": "string",
                "paidAmount": {
                  "value": 1000,
                  "currencyCode": "GBP"
                },
                "tipsAmount": {
                  "value": 1000,
                  "currencyCode": "GBP"
                }
              }
            ]
          }
        }
      ],
      "before": "string",
      "after": "string"
    }
  }
  

  This example has been generated automatically.

• SUB SearchPartiesV1

  Accepts the following message:

  <anonymous-message-26>

  Payload

  object allOf

  uid: SearchPartiesJsonrpcRequestV1

  Consists of:

  object

  uid: JsonrpcRequestV1

  id

  required

  string

  method

  required

  string

  jsonrpc

  required

  string

  Additional properties are allowed.

  And with:

  object

  uid: SearchPartiesParams

  params

  required

  object

  uid: SearchPartiesRequest

  tableId

  string

  fromTime

  string

  format: date-time

  cursor

  object

  uid: Cursor

  A cursor for use in pagination.

  limit

  integer

  <= 100

  The maximum number of results to be returned in a single page.

  Response

  Const:

  ""

  before

  string

  A cursor for use in pagination for the previous page. before and after are mutually exclusive. Only one of these may be used.

  Response

  Const:

  ""

  after

  string

  A cursor for use in pagination for the next page. before and after are mutually exclusive. Only one of these may be used.

  Response

  Const:

  ""

  Response

  Const:

  ""

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "method": "string",
    "jsonrpc": "string",
    "params": {
      "tableId": "string",
      "fromTime": "2019-08-24T14:15:22Z",
      "cursor": {
        "limit": 100,
        "before": "string",
        "after": "string"
      }
    }
  }
  

  This example has been generated automatically.

• PUB SearchReservationsV1

  Accepts the following message:

  <anonymous-message-27>

  Payload

  object allOf

  uid: PagedReservationsJsonrpcResponseV1

  Consists of:

  object

  uid: JsonrpcResponseV1

  id

  required

  string

  error

  object

  uid: Error

  Additional properties are allowed.

  jsonrpc

  required

  string

  Additional properties are allowed.

  And with:

  object

  uid: PagedReservationsResult

  result

  required

  object

  uid: PagedReservationsResponse

  data

  required

  array<object>

  uid: Reservation

  id

  required

  string

  name

  required

  string

  covers

  required

  integer

  startTime

  required

  string

  format: date-time

  When the reservation is expected to arrive. ISO8601 formatted, ms precise.

  endTime

  required

  string

  format: date-time

  When the reservation is expected to depart. ISO8601 formatted, ms precise.

  tableIds

  required

  array<string>

  non-empty

  Items:

  string

  hostNotes

  string

  guestRequests

  string

  Response

  Const:

  ""

  before

  string

  Response

  Const:

  ""

  after

  string

  Response

  Const:

  ""

  Response

  Const:

  ""

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "error": {},
    "jsonrpc": "string",
    "result": {
      "data": [
        {
          "id": "string",
          "name": "string",
          "covers": 0,
          "startTime": "2019-08-24T14:15:22Z",
          "endTime": "2019-08-24T14:15:22Z",
          "tableIds": [
            "string"
          ],
          "hostNotes": "string",
          "guestRequests": "string"
        }
      ],
      "before": "string",
      "after": "string"
    }
  }
  

  This example has been generated automatically.

• SUB SearchReservationsV1

  Accepts the following message:

  <anonymous-message-28>

  Payload

  object allOf

  uid: SearchReservationsJsonrpcRequestV1

  Consists of:

  object

  uid: JsonrpcRequestV1

  id

  required

  string

  method

  required

  string

  jsonrpc

  required

  string

  Additional properties are allowed.

  And with:

  object

  uid: SearchReservationsParams

  params

  required

  object

  uid: SearchReservationsRequest

  tableId

  string

  fromTime

  string

  format: date-time

  toTime

  string

  format: date-time

  cursor

  object

  uid: Cursor

  A cursor for use in pagination.

  limit

  integer

  <= 100

  The maximum number of results to be returned in a single page.

  Response

  Const:

  ""

  before

  string

  A cursor for use in pagination for the previous page. before and after are mutually exclusive. Only one of these may be used.

  Response

  Const:

  ""

  after

  string

  A cursor for use in pagination for the next page. before and after are mutually exclusive. Only one of these may be used.

  Response

  Const:

  ""

  Response

  Const:

  ""

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "method": "string",
    "jsonrpc": "string",
    "params": {
      "tableId": "string",
      "fromTime": "2019-08-24T14:15:22Z",
      "toTime": "2019-08-24T14:15:22Z",
      "cursor": {
        "limit": 100,
        "before": "string",
        "after": "string"
      }
    }
  }
  

  This example has been generated automatically.

• PUB SearchTablesV1

  Accepts the following message:

  <anonymous-message-29>

  Payload

  object allOf

  uid: PagedTablesJsonrpcResponseV1

  Consists of:

  object

  uid: JsonrpcResponseV1

  id

  required

  string

  error

  object

  uid: Error

  Additional properties are allowed.

  jsonrpc

  required

  string

  Additional properties are allowed.

  And with:

  object

  uid: PagedTablesResult

  result

  required

  object

  uid: PagedTablesResponse

  data

  required

  array<object>

  uid: Table

  id

  required

  string

  name

  required

  string

  User friendly name to identify the table. Must be unique for an area. Will be displayed on the card machine.

  maxCovers

  integer

  format: int32

  Max number of covers at this table.

  areaId

  string

  ID of an area

  waiterIds

  array<string>

  An array of waiter IDs serving this table

  Items:

  string

  Response

  Const:

  ""

  before

  string

  Response

  Const:

  ""

  after

  string

  Response

  Const:

  ""

  Response

  Const:

  ""

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "error": {},
    "jsonrpc": "string",
    "result": {
      "data": [
        {
          "id": "tbl_12345",
          "name": "Table 12",
          "maxCovers": 4,
          "areaId": "area_123"
        }
      ],
      "before": "string",
      "after": "string"
    }
  }
  

  This example has been generated automatically.

• SUB SearchTablesV1

  Accepts the following message:

  <anonymous-message-30>

  Payload

  object allOf

  uid: SearchTablesJsonrpcRequestV1

  Consists of:

  object

  uid: JsonrpcRequestV1

  id

  required

  string

  method

  required

  string

  jsonrpc

  required

  string

  Additional properties are allowed.

  And with:

  object

  uid: SearchTablesParams

  params

  required

  object

  uid: SearchTablesRequest

  areaId

  string

  waiterId

  string

  cursor

  object

  uid: Cursor

  A cursor for use in pagination.

  limit

  integer

  <= 100

  The maximum number of results to be returned in a single page.

  Response

  Const:

  ""

  before

  string

  A cursor for use in pagination for the previous page. before and after are mutually exclusive. Only one of these may be used.

  Response

  Const:

  ""

  after

  string

  A cursor for use in pagination for the next page. before and after are mutually exclusive. Only one of these may be used.

  Response

  Const:

  ""

  Response

  Const:

  ""

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "id": "string",
    "method": "string",
    "jsonrpc": "string",
    "params": {
      "areaId": "string",
      "waiterId": "string",
      "cursor": {
        "limit": 100,
        "before": "string",
        "after": "string"
      }
    }
  }
  

  This example has been generated automatically.