Orders

List all orders.

get

Authorizations

api-key

api-keystringRequired

API Key

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

400

Functional Error

application/json

get/v1/om/orders

HTTPcURLJavaScriptPython

GET /v1/om/orders HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "orders": [
      {
        "branchUid": "text",
        "businessDate": "text",
        "numberOfGuests": 1,
        "type": "delivery",
        "status": "canceled",
        "closedAt": "text",
        "canceledAt": "text",
        "readyForPickup": true,
        "readyForPickupAt": "text",
        "callNumber": 1,
        "callSource": "text",
        "checkPrintCount": 1,
        "invoicePrintCount": 1,
        "noteToKitchen": "text",
        "internalNote": "text",
        "total": 1,
        "gross": 1,
        "subtotal": 1,
        "tax": 1,
        "totalDiscount": 1,
        "subtotalDiscount": 1,
        "taxDiscount": 1,
        "totalLineDiscounts": 1,
        "balanceDue": 1,
        "prepaidTaxable": 1,
        "prepaidTax": 1,
        "totalPrepaid": 1,
        "appendLoyaltyBenefits": true,
        "shipTo": {
          "building": "text",
          "street": "text",
          "secondary": "text",
          "district": "text",
          "postalCode": "text",
          "city": "text",
          "uid": "text"
        },
        "displayId": "text",
        "source": "text",
        "channelOrderDisplayId": "text",
        "prepareTime": 1,
        "estimatedPickupAt": "text",
        "estimatedDeliveryAt": "text",
        "externalData": {},
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text",
        "id": "text",
        "uid": "text",
        "fuid": "text",
        "branchId": "text",
        "formattedShortNumber": "text",
        "can": [
          "cancel"
        ],
        "paidAmount": 1,
        "userUid": "text",
        "customerUid": "text",
        "tableUids": [
          "text"
        ],
        "lines": [
          {
            "quantity": 1,
            "note": "text",
            "seats": [
              1
            ],
            "course": 1,
            "status": "Comped",
            "productType": "combo",
            "sentAt": "text",
            "sentPrinting": {},
            "firePrinting": {},
            "voidPrinting": {},
            "lastPrintTime": "text",
            "firedAt": "text",
            "voidedAt": "text",
            "voidReasonId": "text",
            "voidWaste": true,
            "requestedAt": "text",
            "acceptedAt": "text",
            "rejectedAt": "text",
            "rejectReasonId": "text",
            "price": 1,
            "amount": 1,
            "tax": 1,
            "subtotal": 1,
            "taxRate": 1,
            "subtotalDiscounts": 1,
            "taxDiscounts": 1,
            "totalDiscounts": 1,
            "gross": 1,
            "dueAmount": 1,
            "orderDiscountsSubtotal": 1,
            "orderDiscountsTax": 1,
            "orderAppliedDiscounts": [
              {
                "id": "text",
                "amount": 1,
                "subtotal": 1,
                "tax": 1
              }
            ],
            "voucherUid": "text",
            "invoiceId": "text",
            "comboLineId": "text",
            "comboOptionUid": "text",
            "locked": true,
            "lockedBy": "text",
            "lockedAt": "text",
            "createdAt": "text",
            "createdVia": "text",
            "createdBy": "text",
            "updatedAt": "text",
            "updatedVia": "text",
            "updatedBy": "text",
            "id": "text",
            "uid": "text",
            "productUid": "text",
            "uomUid": "text",
            "appliedModifiers": [
              {
                "id": "text",
                "options": [
                  {
                    "quantity": 1,
                    "amount": 1,
                    "price": 1,
                    "visible": true,
                    "createdAt": "text",
                    "createdVia": "text",
                    "createdBy": "text",
                    "updatedAt": "text",
                    "updatedVia": "text",
                    "updatedBy": "text",
                    "id": "text",
                    "modifierUid": "text"
                  }
                ]
              }
            ],
            "appliedDiscounts": [
              {
                "type": "custom-fixed",
                "value": 1,
                "excludeTax": true,
                "source": "deliverect",
                "sourceId": "text",
                "locales": {},
                "amount": 1,
                "subtotalAmount": 1,
                "taxAmount": 1,
                "reasonId": "text",
                "comment": "text",
                "invoiceId": "text",
                "id": "text"
              }
            ],
            "can": [
              "accept"
            ],
            "subinventoryUid": "text",
            "returns": [
              {
                "quantity": 1,
                "waste": true,
                "invoiceId": "text",
                "reasonId": "text",
                "price": 1,
                "amount": 1,
                "subtotal": 1,
                "tax": 1,
                "gross": 1,
                "createdAt": "text",
                "createdVia": "text",
                "createdBy": "text",
                "updatedAt": "text",
                "updatedVia": "text",
                "updatedBy": "text",
                "id": "text",
                "uid": "text"
              }
            ],
            "returnedQuantity": 1
          }
        ],
        "appliedDiscounts": [
          {
            "type": "custom-fixed",
            "value": 1,
            "excludeTax": true,
            "source": "deliverect",
            "sourceId": "text",
            "locales": {},
            "amount": 1,
            "subtotalAmount": 1,
            "taxAmount": 1,
            "reasonId": "text",
            "comment": "text",
            "invoiceId": "text",
            "id": "text"
          }
        ],
        "payments": [
          {
            "type": "receipt",
            "status": "complete",
            "completedAt": "text",
            "reversedAt": "text",
            "custom": true,
            "amount": 1,
            "sourcePaymentId": "text",
            "transactionRef": "text",
            "attrs": {},
            "invoiceId": "text",
            "note": "text",
            "createdAt": "text",
            "createdVia": "text",
            "createdBy": "text",
            "updatedAt": "text",
            "updatedVia": "text",
            "updatedBy": "text",
            "id": "text",
            "can": [
              "confirm"
            ],
            "methodUid": "text"
          }
        ],
        "invoices": [
          {
            "type": "credit-note",
            "status": "closed",
            "number": 1,
            "source": "text",
            "closedAt": "text",
            "referenceInvoiceId": "text",
            "applyExpiresAt": "text",
            "checkPrintCount": 1,
            "invoicePrintCount": 1,
            "totalDiscount": 1,
            "taxDiscount": 1,
            "subtotalDiscount": 1,
            "subtotal": 1,
            "tax": 1,
            "gross": 1,
            "taxable": 1,
            "total": 1,
            "totalLineDiscounts": 1,
            "prepaidTaxable": 1,
            "prepaidTax": 1,
            "totalPrepaid": 1,
            "balanceDue": 1,
            "id": "text",
            "uid": "text",
            "paidAmount": 1,
            "appliedInvoices": [
              {
                "code": "text",
                "balance": 1,
                "taxableBalance": 1,
                "taxBalance": 1,
                "sourceDate": "text",
                "createdAt": "text",
                "createdVia": "text",
                "createdBy": "text",
                "updatedAt": "text",
                "updatedVia": "text",
                "updatedBy": "text",
                "uid": "text"
              }
            ],
            "appliedDiscounts": [
              {
                "type": "custom-fixed",
                "value": 1,
                "excludeTax": true,
                "source": "deliverect",
                "sourceId": "text",
                "locales": {},
                "amount": 1,
                "subtotalAmount": 1,
                "taxAmount": 1,
                "reasonId": "text",
                "comment": "text",
                "invoiceId": "text",
                "id": "text"
              }
            ],
            "lines": [
              {
                "id": "text",
                "uid": "text",
                "price": 1,
                "amount": 1,
                "dueAmount": 1,
                "tax": 1,
                "subtotal": 1,
                "taxRate": 1,
                "gross": 1,
                "quantity": 1,
                "productUid": "text",
                "subtotalDiscounts": 1,
                "taxDiscounts": 1,
                "totalDiscounts": 1,
                "referenceLineId": "text",
                "status": "Comped",
                "appliedDiscounts": [
                  {
                    "type": "custom-fixed",
                    "value": 1,
                    "excludeTax": true,
                    "source": "deliverect",
                    "sourceId": "text",
                    "locales": {},
                    "amount": 1,
                    "subtotalAmount": 1,
                    "taxAmount": 1,
                    "reasonId": "text",
                    "comment": "text",
                    "invoiceId": "text",
                    "id": "text"
                  }
                ]
              }
            ],
            "can": [
              "close"
            ]
          }
        ],
        "alerts": [
          {
            "type": "order-not-sent"
          }
        ],
        "channelUid": "text",
        "externalId": "text",
        "estimatedReadyAt": "text",
        "sessionUid": "text"
      }
    ],
    "users": [
      {
        "firstName": "text",
        "lastName": "text",
        "email": "text",
        "phone": "text",
        "phoneCountry": "text",
        "phoneCountryCalling": "text",
        "sequence": 1,
        "number": "text",
        "cityId": "text",
        "birthDate": "text",
        "gender": {},
        "passcode": "text",
        "unsubscribed": true,
        "internalNote": "text",
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text",
        "id": "text",
        "roleAssignments": [
          {
            "endDate": "text",
            "id": "text"
          }
        ]
      }
    ],
    "customers": [
      {
        "firstName": "text",
        "lastName": "text",
        "email": "text",
        "phone": "text",
        "phoneCountry": "text",
        "phoneCountryCalling": "text",
        "sequence": 1,
        "number": "text",
        "cityId": "text",
        "birthDate": "text",
        "gender": {},
        "passcode": "text",
        "unsubscribed": true,
        "internalNote": "text",
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text",
        "id": "text",
        "roleAssignments": [
          {
            "endDate": "text",
            "id": "text"
          }
        ]
      }
    ],
    "tables": [
      {
        "name": "text",
        "x": 1,
        "y": 1,
        "width": 1,
        "height": 1,
        "circle": true,
        "minSeats": 1,
        "maxSeats": 1,
        "archived": true,
        "id": "text",
        "areaId": "text"
      }
    ],
    "areas": [
      {
        "locales": {},
        "backgroundImage": "text",
        "id": "text",
        "branchId": "text"
      }
    ],
    "paymentMethods": [
      {
        "locales": {
          "ar": {
            "name": "text",
            "description": "text"
          },
          "en": {
            "name": "text",
            "description": "text"
          }
        },
        "visible": true,
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text",
        "id": "text"
      }
    ],
    "products": [
      {
        "image": "text",
        "price": 1,
        "locales": {},
        "calories": 1,
        "sort": 1,
        "allergies": [
          "text"
        ],
        "active": true,
        "posImageUrl": "text",
        "type": "combo",
        "sku": "text",
        "inventory": true,
        "primaryUomUid": "text",
        "voucherValidaty": 1,
        "voucherPayLimit": 1,
        "voucherSharingLimit": 1,
        "voucherAccess": "anonymous",
        "voucherDirectPay": true,
        "voucherTopup": true,
        "voucherAutoTopup": true,
        "voucherActivationEndDate": "text",
        "id": "text",
        "categoryId": "text",
        "taxGroupUid": "text",
        "bomUid": "text",
        "listUids": [
          "text"
        ],
        "comboGroups": [
          {
            "locales": {},
            "min": 1,
            "max": 1,
            "uid": "text",
            "options": [
              {
                "upcharge": 1,
                "selected": true,
                "uid": "text",
                "productUId": "text"
              }
            ]
          }
        ],
        "modifiers": [
          {
            "minSelection": 1,
            "maxSelection": 1,
            "createdAt": "text",
            "createdVia": "text",
            "createdBy": "text",
            "updatedAt": "text",
            "updatedVia": "text",
            "updatedBy": "text",
            "id": "text",
            "options": [
              {
                "defaultQuantity": 1,
                "createdAt": "text",
                "createdVia": "text",
                "createdBy": "text",
                "updatedAt": "text",
                "updatedVia": "text",
                "updatedBy": "text",
                "id": "text"
              }
            ]
          }
        ]
      }
    ],
    "categories": [
      {
        "image": "text",
        "locales": {},
        "sort": 1,
        "id": "text"
      }
    ],
    "discounts": [
      {
        "locales": {
          "ar": {
            "name": "text",
            "description": "text"
          },
          "en": {
            "name": "text",
            "description": "text"
          }
        },
        "type": "fixed",
        "value": 1,
        "qualifications": [
          "line"
        ],
        "orderTypes": [
          "delivery"
        ],
        "max": 1,
        "isActive": true,
        "excludeTax": true,
        "reasonRequired": true,
        "commentRequired": true,
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text",
        "id": "text",
        "rules": [
          {
            "conditions": [
              {
                "key": "level",
                "operator": "contains",
                "value": "text"
              }
            ],
            "action": "exclude",
            "id": "text"
          }
        ]
      }
    ],
    "nextId": "text",
    "query": {}
  }
}

Creates a new Order.

post

Authorizations

api-key

api-keystringRequired

API Key

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

post/v1/om/orders

HTTPcURLJavaScriptPython

POST /v1/om/orders HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 709

{
  "params": {
    "branchId": "text",
    "tableIds": [
      "text"
    ],
    "customerId": "text",
    "userId": "text",
    "numberOfGuests": 1,
    "type": "delivery",
    "appendLoyaltyBenefits": true,
    "invoiceType": "prepayment",
    "callNumber": 1,
    "callSource": "text",
    "deviceId": "text",
    "applyExpiresAt": "text",
    "externalId": "text",
    "externalData": {
      "ar": {
        "name": "text",
        "description": "text"
      },
      "en": {
        "name": "text",
        "description": "text"
      }
    },
    "shipTo": {
      "building": "text",
      "street": "text",
      "secondary": "text",
      "district": "text",
      "postalCode": "text",
      "city": "text",
      "uid": "text"
    },
    "displayId": "text",
    "source": "text",
    "channelUid": "text",
    "channelOrderDisplayId": "text",
    "noteToKitchen": "text",
    "internalNote": "text",
    "prepareTime": 1,
    "estimatedPickupAt": "text",
    "estimatedDeliveryAt": "text"
  }
}

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "id": "text"
  }
}

Returns an order.

get

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

400

Functional Error

application/json

get/v1/om/orders/{uid}

HTTPcURLJavaScriptPython

GET /v1/om/orders/{uid} HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "order": {
      "branchUid": "text",
      "businessDate": "text",
      "numberOfGuests": 1,
      "type": "delivery",
      "status": "canceled",
      "closedAt": "text",
      "canceledAt": "text",
      "readyForPickup": true,
      "readyForPickupAt": "text",
      "callNumber": 1,
      "callSource": "text",
      "checkPrintCount": 1,
      "invoicePrintCount": 1,
      "noteToKitchen": "text",
      "internalNote": "text",
      "total": 1,
      "gross": 1,
      "subtotal": 1,
      "tax": 1,
      "totalDiscount": 1,
      "subtotalDiscount": 1,
      "taxDiscount": 1,
      "totalLineDiscounts": 1,
      "balanceDue": 1,
      "prepaidTaxable": 1,
      "prepaidTax": 1,
      "totalPrepaid": 1,
      "appendLoyaltyBenefits": true,
      "shipTo": {
        "building": "text",
        "street": "text",
        "secondary": "text",
        "district": "text",
        "postalCode": "text",
        "city": "text",
        "uid": "text"
      },
      "displayId": "text",
      "source": "text",
      "channelOrderDisplayId": "text",
      "prepareTime": 1,
      "estimatedPickupAt": "text",
      "estimatedDeliveryAt": "text",
      "externalData": {},
      "createdAt": "text",
      "createdVia": "text",
      "createdBy": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "updatedBy": "text",
      "id": "text",
      "uid": "text",
      "fuid": "text",
      "branchId": "text",
      "formattedShortNumber": "text",
      "can": [
        "cancel"
      ],
      "paidAmount": 1,
      "userUid": "text",
      "customerUid": "text",
      "tableUids": [
        "text"
      ],
      "lines": [
        {
          "quantity": 1,
          "note": "text",
          "seats": [
            1
          ],
          "course": 1,
          "status": "Comped",
          "productType": "combo",
          "sentAt": "text",
          "sentPrinting": {},
          "firePrinting": {},
          "voidPrinting": {},
          "lastPrintTime": "text",
          "firedAt": "text",
          "voidedAt": "text",
          "voidReasonId": "text",
          "voidWaste": true,
          "requestedAt": "text",
          "acceptedAt": "text",
          "rejectedAt": "text",
          "rejectReasonId": "text",
          "price": 1,
          "amount": 1,
          "tax": 1,
          "subtotal": 1,
          "taxRate": 1,
          "subtotalDiscounts": 1,
          "taxDiscounts": 1,
          "totalDiscounts": 1,
          "gross": 1,
          "dueAmount": 1,
          "orderDiscountsSubtotal": 1,
          "orderDiscountsTax": 1,
          "orderAppliedDiscounts": [
            {
              "id": "text",
              "amount": 1,
              "subtotal": 1,
              "tax": 1
            }
          ],
          "voucherUid": "text",
          "invoiceId": "text",
          "comboLineId": "text",
          "comboOptionUid": "text",
          "locked": true,
          "lockedBy": "text",
          "lockedAt": "text",
          "createdAt": "text",
          "createdVia": "text",
          "createdBy": "text",
          "updatedAt": "text",
          "updatedVia": "text",
          "updatedBy": "text",
          "id": "text",
          "uid": "text",
          "productUid": "text",
          "uomUid": "text",
          "appliedModifiers": [
            {
              "id": "text",
              "options": [
                {
                  "quantity": 1,
                  "amount": 1,
                  "price": 1,
                  "visible": true,
                  "createdAt": "text",
                  "createdVia": "text",
                  "createdBy": "text",
                  "updatedAt": "text",
                  "updatedVia": "text",
                  "updatedBy": "text",
                  "id": "text",
                  "modifierUid": "text"
                }
              ]
            }
          ],
          "appliedDiscounts": [
            {
              "type": "custom-fixed",
              "value": 1,
              "excludeTax": true,
              "source": "deliverect",
              "sourceId": "text",
              "locales": {},
              "amount": 1,
              "subtotalAmount": 1,
              "taxAmount": 1,
              "reasonId": "text",
              "comment": "text",
              "invoiceId": "text",
              "id": "text"
            }
          ],
          "can": [
            "accept"
          ],
          "subinventoryUid": "text",
          "returns": [
            {
              "quantity": 1,
              "waste": true,
              "invoiceId": "text",
              "reasonId": "text",
              "price": 1,
              "amount": 1,
              "subtotal": 1,
              "tax": 1,
              "gross": 1,
              "createdAt": "text",
              "createdVia": "text",
              "createdBy": "text",
              "updatedAt": "text",
              "updatedVia": "text",
              "updatedBy": "text",
              "id": "text",
              "uid": "text"
            }
          ],
          "returnedQuantity": 1
        }
      ],
      "appliedDiscounts": [
        {
          "type": "custom-fixed",
          "value": 1,
          "excludeTax": true,
          "source": "deliverect",
          "sourceId": "text",
          "locales": {},
          "amount": 1,
          "subtotalAmount": 1,
          "taxAmount": 1,
          "reasonId": "text",
          "comment": "text",
          "invoiceId": "text",
          "id": "text"
        }
      ],
      "payments": [
        {
          "type": "receipt",
          "status": "complete",
          "completedAt": "text",
          "reversedAt": "text",
          "custom": true,
          "amount": 1,
          "sourcePaymentId": "text",
          "transactionRef": "text",
          "attrs": {},
          "invoiceId": "text",
          "note": "text",
          "createdAt": "text",
          "createdVia": "text",
          "createdBy": "text",
          "updatedAt": "text",
          "updatedVia": "text",
          "updatedBy": "text",
          "id": "text",
          "can": [
            "confirm"
          ],
          "methodUid": "text"
        }
      ],
      "invoices": [
        {
          "type": "credit-note",
          "status": "closed",
          "number": 1,
          "source": "text",
          "closedAt": "text",
          "referenceInvoiceId": "text",
          "applyExpiresAt": "text",
          "checkPrintCount": 1,
          "invoicePrintCount": 1,
          "totalDiscount": 1,
          "taxDiscount": 1,
          "subtotalDiscount": 1,
          "subtotal": 1,
          "tax": 1,
          "gross": 1,
          "taxable": 1,
          "total": 1,
          "totalLineDiscounts": 1,
          "prepaidTaxable": 1,
          "prepaidTax": 1,
          "totalPrepaid": 1,
          "balanceDue": 1,
          "id": "text",
          "uid": "text",
          "paidAmount": 1,
          "appliedInvoices": [
            {
              "code": "text",
              "balance": 1,
              "taxableBalance": 1,
              "taxBalance": 1,
              "sourceDate": "text",
              "createdAt": "text",
              "createdVia": "text",
              "createdBy": "text",
              "updatedAt": "text",
              "updatedVia": "text",
              "updatedBy": "text",
              "uid": "text"
            }
          ],
          "appliedDiscounts": [
            {
              "type": "custom-fixed",
              "value": 1,
              "excludeTax": true,
              "source": "deliverect",
              "sourceId": "text",
              "locales": {},
              "amount": 1,
              "subtotalAmount": 1,
              "taxAmount": 1,
              "reasonId": "text",
              "comment": "text",
              "invoiceId": "text",
              "id": "text"
            }
          ],
          "lines": [
            {
              "id": "text",
              "uid": "text",
              "price": 1,
              "amount": 1,
              "dueAmount": 1,
              "tax": 1,
              "subtotal": 1,
              "taxRate": 1,
              "gross": 1,
              "quantity": 1,
              "productUid": "text",
              "subtotalDiscounts": 1,
              "taxDiscounts": 1,
              "totalDiscounts": 1,
              "referenceLineId": "text",
              "status": "Comped",
              "appliedDiscounts": [
                {
                  "type": "custom-fixed",
                  "value": 1,
                  "excludeTax": true,
                  "source": "deliverect",
                  "sourceId": "text",
                  "locales": {},
                  "amount": 1,
                  "subtotalAmount": 1,
                  "taxAmount": 1,
                  "reasonId": "text",
                  "comment": "text",
                  "invoiceId": "text",
                  "id": "text"
                }
              ]
            }
          ],
          "can": [
            "close"
          ]
        }
      ],
      "alerts": [
        {
          "type": "order-not-sent"
        }
      ],
      "channelUid": "text",
      "externalId": "text",
      "estimatedReadyAt": "text",
      "sessionUid": "text"
    },
    "user": {},
    "customer": {},
    "tables": [
      {
        "name": "text",
        "x": 1,
        "y": 1,
        "width": 1,
        "height": 1,
        "circle": true,
        "minSeats": 1,
        "maxSeats": 1,
        "archived": true,
        "id": "text",
        "areaId": "text"
      }
    ],
    "areas": [
      {
        "locales": {},
        "backgroundImage": "text",
        "id": "text",
        "branchId": "text"
      }
    ],
    "paymentMethods": [
      {
        "locales": {
          "ar": {
            "name": "text",
            "description": "text"
          },
          "en": {
            "name": "text",
            "description": "text"
          }
        },
        "visible": true,
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text",
        "id": "text"
      }
    ],
    "products": [
      {
        "image": "text",
        "price": 1,
        "locales": {},
        "calories": 1,
        "sort": 1,
        "allergies": [
          "text"
        ],
        "active": true,
        "posImageUrl": "text",
        "type": "combo",
        "sku": "text",
        "inventory": true,
        "primaryUomUid": "text",
        "voucherValidaty": 1,
        "voucherPayLimit": 1,
        "voucherSharingLimit": 1,
        "voucherAccess": "anonymous",
        "voucherDirectPay": true,
        "voucherTopup": true,
        "voucherAutoTopup": true,
        "voucherActivationEndDate": "text",
        "id": "text",
        "categoryId": "text",
        "taxGroupUid": "text",
        "bomUid": "text",
        "listUids": [
          "text"
        ],
        "comboGroups": [
          {
            "locales": {},
            "min": 1,
            "max": 1,
            "uid": "text",
            "options": [
              {
                "upcharge": 1,
                "selected": true,
                "uid": "text",
                "productUId": "text"
              }
            ]
          }
        ],
        "modifiers": [
          {
            "minSelection": 1,
            "maxSelection": 1,
            "createdAt": "text",
            "createdVia": "text",
            "createdBy": "text",
            "updatedAt": "text",
            "updatedVia": "text",
            "updatedBy": "text",
            "id": "text",
            "options": [
              {
                "defaultQuantity": 1,
                "createdAt": "text",
                "createdVia": "text",
                "createdBy": "text",
                "updatedAt": "text",
                "updatedVia": "text",
                "updatedBy": "text",
                "id": "text"
              }
            ]
          }
        ]
      }
    ],
    "modifiers": [
      {
        "locales": {},
        "minSelection": 1,
        "maxSelection": 1,
        "id": "text",
        "options": [
          {
            "id": "text",
            "locales": {},
            "price": 1,
            "isActive": true,
            "sortNumber": 1,
            "multiple": true,
            "createdAt": "text",
            "createdVia": "text",
            "createdBy": "text",
            "updatedAt": "text",
            "updatedVia": "text",
            "updatedBy": "text",
            "uomAssignmentUid": "text",
            "uomUid": "text",
            "productUid": "text"
          }
        ]
      }
    ],
    "discounts": [
      {
        "locales": {
          "ar": {
            "name": "text",
            "description": "text"
          },
          "en": {
            "name": "text",
            "description": "text"
          }
        },
        "type": "fixed",
        "value": 1,
        "qualifications": [
          "line"
        ],
        "orderTypes": [
          "delivery"
        ],
        "max": 1,
        "isActive": true,
        "excludeTax": true,
        "reasonRequired": true,
        "commentRequired": true,
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text",
        "id": "text",
        "rules": [
          {
            "conditions": [
              {
                "key": "level",
                "operator": "contains",
                "value": "text"
              }
            ],
            "action": "exclude",
            "id": "text"
          }
        ]
      }
    ]
  }
}

Updates an order.

patch

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

400

Functional Error

application/json

patch/v1/om/orders/{uid}

HTTPcURLJavaScriptPython

PATCH /v1/om/orders/{uid} HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 337

{
  "params": {
    "tableIds": [
      "text"
    ],
    "customerId": "text",
    "userId": "text",
    "numberOfGuests": 1,
    "noteToKitchen": "text",
    "internalNote": "text",
    "type": {},
    "externalData": {
      "ar": {
        "name": "text",
        "description": "text"
      },
      "en": {
        "name": "text",
        "description": "text"
      }
    },
    "readyForPickup": true,
    "prepareTime": 1,
    "estimatedPickupAt": "text",
    "estimatedDeliveryAt": "text"
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true
  }
}

Finalizes and closes the specified order.

patch

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

400

Functional Error

application/json

patch/v1/om/orders/{uid}/close

HTTPcURLJavaScriptPython

PATCH /v1/om/orders/{uid}/close HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

{
  "params": {
    "id": "text"
  }
}

Cancels an order.

patch

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

ErrorCodesstring · enumRequiredPossible values:

400

Functional Error

application/json

patch/v1/om/orders/{uid}/cancel

HTTPcURLJavaScriptPython

PATCH /v1/om/orders/{uid}/cancel HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

{
  "Params": {
    "id": "text"
  },
  "Data": {
    "succeed": true
  },
  "ErrorCodes": "ALREADY_CLOSED"
}

Voids an order.

patch

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

400

Functional Error

application/json

patch/v1/om/orders/{uid}/void

HTTPcURLJavaScriptPython

PATCH /v1/om/orders/{uid}/void HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "params": {
    "waste": true,
    "reasonId": "text"
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true
  }
}

Exports all orders with support for incremental fetching.

get

Authorizations

api-key

api-keystringRequired

API Key

Query parameters

updatedSincestringOptional

offsetstringOptional

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

objectOptional

get/v1/om/orders/export

HTTPcURLJavaScriptPython

GET /v1/om/orders/export HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

200Success

{}

Applies a discount at order level.

patch

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

dataobject · ApplyDiscount_DataRequired

400

Functional Error

application/json

patch/v1/om/orders/{uid}/discount

HTTPcURLJavaScriptPython

PATCH /v1/om/orders/{uid}/discount HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "params": {
    "discountId": "text",
    "source": "deliverect",
    "reasonId": "text",
    "comment": "text"
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {}
}

Updates applied discount at order level.

patch

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

400

Functional Error

application/json

patch/v1/om/orders/{uid}/update-discount

HTTPcURLJavaScriptPython

PATCH /v1/om/orders/{uid}/update-discount HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "params": {
    "discountId": "text",
    "source": "deliverect",
    "reasonId": "text",
    "comment": "text"
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true
  }
}

Cancels a discount at order level.

patch

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

dataobject · CancelDiscount_DataRequired

400

Functional Error

application/json

patch/v1/om/orders/{uid}/cancel-discount

HTTPcURLJavaScriptPython

PATCH /v1/om/orders/{uid}/cancel-discount HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "params": {
    "discountId": "text"
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {}
}

Applies a custom discount at order level.

patch

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

dataobject · ApplyCustomDiscount_DataRequired

400

Functional Error

application/json

patch/v1/om/orders/{uid}/custom-discount

HTTPcURLJavaScriptPython

PATCH /v1/om/orders/{uid}/custom-discount HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 231

{
  "params": {
    "type": "custom-fixed",
    "value": 1,
    "excludeTax": true,
    "source": "deliverect",
    "sourceId": "text",
    "locales": {
      "ar": {
        "name": "text",
        "description": "text"
      },
      "en": {
        "name": "text",
        "description": "text"
      }
    },
    "subtotalAmount": 1,
    "taxAmount": 1
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {}
}

Returns an order by external ID.

get

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

externalIdstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

400

Functional Error

application/json

get/v1/om/orders/by-external/{externalId}

HTTPcURLJavaScriptPython

GET /v1/om/orders/by-external/{externalId} HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "order": {
      "branchUid": "text",
      "businessDate": "text",
      "numberOfGuests": 1,
      "type": "delivery",
      "status": "canceled",
      "closedAt": "text",
      "canceledAt": "text",
      "readyForPickup": true,
      "readyForPickupAt": "text",
      "callNumber": 1,
      "callSource": "text",
      "checkPrintCount": 1,
      "invoicePrintCount": 1,
      "noteToKitchen": "text",
      "internalNote": "text",
      "total": 1,
      "gross": 1,
      "subtotal": 1,
      "tax": 1,
      "totalDiscount": 1,
      "subtotalDiscount": 1,
      "taxDiscount": 1,
      "totalLineDiscounts": 1,
      "balanceDue": 1,
      "prepaidTaxable": 1,
      "prepaidTax": 1,
      "totalPrepaid": 1,
      "appendLoyaltyBenefits": true,
      "shipTo": {
        "building": "text",
        "street": "text",
        "secondary": "text",
        "district": "text",
        "postalCode": "text",
        "city": "text",
        "uid": "text"
      },
      "displayId": "text",
      "source": "text",
      "channelOrderDisplayId": "text",
      "prepareTime": 1,
      "estimatedPickupAt": "text",
      "estimatedDeliveryAt": "text",
      "externalData": {},
      "createdAt": "text",
      "createdVia": "text",
      "createdBy": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "updatedBy": "text",
      "id": "text",
      "uid": "text",
      "fuid": "text",
      "branchId": "text",
      "formattedShortNumber": "text",
      "can": [
        "cancel"
      ],
      "paidAmount": 1,
      "userUid": "text",
      "customerUid": "text",
      "tableUids": [
        "text"
      ],
      "lines": [
        {
          "quantity": 1,
          "note": "text",
          "seats": [
            1
          ],
          "course": 1,
          "status": "Comped",
          "productType": "combo",
          "sentAt": "text",
          "sentPrinting": {},
          "firePrinting": {},
          "voidPrinting": {},
          "lastPrintTime": "text",
          "firedAt": "text",
          "voidedAt": "text",
          "voidReasonId": "text",
          "voidWaste": true,
          "requestedAt": "text",
          "acceptedAt": "text",
          "rejectedAt": "text",
          "rejectReasonId": "text",
          "price": 1,
          "amount": 1,
          "tax": 1,
          "subtotal": 1,
          "taxRate": 1,
          "subtotalDiscounts": 1,
          "taxDiscounts": 1,
          "totalDiscounts": 1,
          "gross": 1,
          "dueAmount": 1,
          "orderDiscountsSubtotal": 1,
          "orderDiscountsTax": 1,
          "orderAppliedDiscounts": [
            {
              "id": "text",
              "amount": 1,
              "subtotal": 1,
              "tax": 1
            }
          ],
          "voucherUid": "text",
          "invoiceId": "text",
          "comboLineId": "text",
          "comboOptionUid": "text",
          "locked": true,
          "lockedBy": "text",
          "lockedAt": "text",
          "createdAt": "text",
          "createdVia": "text",
          "createdBy": "text",
          "updatedAt": "text",
          "updatedVia": "text",
          "updatedBy": "text",
          "id": "text",
          "uid": "text",
          "productUid": "text",
          "uomUid": "text",
          "appliedModifiers": [
            {
              "id": "text",
              "options": [
                {
                  "quantity": 1,
                  "amount": 1,
                  "price": 1,
                  "visible": true,
                  "createdAt": "text",
                  "createdVia": "text",
                  "createdBy": "text",
                  "updatedAt": "text",
                  "updatedVia": "text",
                  "updatedBy": "text",
                  "id": "text",
                  "modifierUid": "text"
                }
              ]
            }
          ],
          "appliedDiscounts": [
            {
              "type": "custom-fixed",
              "value": 1,
              "excludeTax": true,
              "source": "deliverect",
              "sourceId": "text",
              "locales": {},
              "amount": 1,
              "subtotalAmount": 1,
              "taxAmount": 1,
              "reasonId": "text",
              "comment": "text",
              "invoiceId": "text",
              "id": "text"
            }
          ],
          "can": [
            "accept"
          ],
          "subinventoryUid": "text",
          "returns": [
            {
              "quantity": 1,
              "waste": true,
              "invoiceId": "text",
              "reasonId": "text",
              "price": 1,
              "amount": 1,
              "subtotal": 1,
              "tax": 1,
              "gross": 1,
              "createdAt": "text",
              "createdVia": "text",
              "createdBy": "text",
              "updatedAt": "text",
              "updatedVia": "text",
              "updatedBy": "text",
              "id": "text",
              "uid": "text"
            }
          ],
          "returnedQuantity": 1
        }
      ],
      "appliedDiscounts": [
        {
          "type": "custom-fixed",
          "value": 1,
          "excludeTax": true,
          "source": "deliverect",
          "sourceId": "text",
          "locales": {},
          "amount": 1,
          "subtotalAmount": 1,
          "taxAmount": 1,
          "reasonId": "text",
          "comment": "text",
          "invoiceId": "text",
          "id": "text"
        }
      ],
      "payments": [
        {
          "type": "receipt",
          "status": "complete",
          "completedAt": "text",
          "reversedAt": "text",
          "custom": true,
          "amount": 1,
          "sourcePaymentId": "text",
          "transactionRef": "text",
          "attrs": {},
          "invoiceId": "text",
          "note": "text",
          "createdAt": "text",
          "createdVia": "text",
          "createdBy": "text",
          "updatedAt": "text",
          "updatedVia": "text",
          "updatedBy": "text",
          "id": "text",
          "can": [
            "confirm"
          ],
          "methodUid": "text"
        }
      ],
      "invoices": [
        {
          "type": "credit-note",
          "status": "closed",
          "number": 1,
          "source": "text",
          "closedAt": "text",
          "referenceInvoiceId": "text",
          "applyExpiresAt": "text",
          "checkPrintCount": 1,
          "invoicePrintCount": 1,
          "totalDiscount": 1,
          "taxDiscount": 1,
          "subtotalDiscount": 1,
          "subtotal": 1,
          "tax": 1,
          "gross": 1,
          "taxable": 1,
          "total": 1,
          "totalLineDiscounts": 1,
          "prepaidTaxable": 1,
          "prepaidTax": 1,
          "totalPrepaid": 1,
          "balanceDue": 1,
          "id": "text",
          "uid": "text",
          "paidAmount": 1,
          "appliedInvoices": [
            {
              "code": "text",
              "balance": 1,
              "taxableBalance": 1,
              "taxBalance": 1,
              "sourceDate": "text",
              "createdAt": "text",
              "createdVia": "text",
              "createdBy": "text",
              "updatedAt": "text",
              "updatedVia": "text",
              "updatedBy": "text",
              "uid": "text"
            }
          ],
          "appliedDiscounts": [
            {
              "type": "custom-fixed",
              "value": 1,
              "excludeTax": true,
              "source": "deliverect",
              "sourceId": "text",
              "locales": {},
              "amount": 1,
              "subtotalAmount": 1,
              "taxAmount": 1,
              "reasonId": "text",
              "comment": "text",
              "invoiceId": "text",
              "id": "text"
            }
          ],
          "lines": [
            {
              "id": "text",
              "uid": "text",
              "price": 1,
              "amount": 1,
              "dueAmount": 1,
              "tax": 1,
              "subtotal": 1,
              "taxRate": 1,
              "gross": 1,
              "quantity": 1,
              "productUid": "text",
              "subtotalDiscounts": 1,
              "taxDiscounts": 1,
              "totalDiscounts": 1,
              "referenceLineId": "text",
              "status": "Comped",
              "appliedDiscounts": [
                {
                  "type": "custom-fixed",
                  "value": 1,
                  "excludeTax": true,
                  "source": "deliverect",
                  "sourceId": "text",
                  "locales": {},
                  "amount": 1,
                  "subtotalAmount": 1,
                  "taxAmount": 1,
                  "reasonId": "text",
                  "comment": "text",
                  "invoiceId": "text",
                  "id": "text"
                }
              ]
            }
          ],
          "can": [
            "close"
          ]
        }
      ],
      "alerts": [
        {
          "type": "order-not-sent"
        }
      ],
      "channelUid": "text",
      "externalId": "text",
      "estimatedReadyAt": "text",
      "sessionUid": "text"
    },
    "user": {},
    "customer": {},
    "tables": [
      {
        "name": "text",
        "x": 1,
        "y": 1,
        "width": 1,
        "height": 1,
        "circle": true,
        "minSeats": 1,
        "maxSeats": 1,
        "archived": true,
        "id": "text",
        "areaId": "text"
      }
    ],
    "areas": [
      {
        "locales": {},
        "backgroundImage": "text",
        "id": "text",
        "branchId": "text"
      }
    ],
    "paymentMethods": [
      {
        "locales": {
          "ar": {
            "name": "text",
            "description": "text"
          },
          "en": {
            "name": "text",
            "description": "text"
          }
        },
        "visible": true,
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text",
        "id": "text"
      }
    ],
    "products": [
      {
        "image": "text",
        "price": 1,
        "locales": {},
        "calories": 1,
        "sort": 1,
        "allergies": [
          "text"
        ],
        "active": true,
        "posImageUrl": "text",
        "type": "combo",
        "sku": "text",
        "inventory": true,
        "primaryUomUid": "text",
        "voucherValidaty": 1,
        "voucherPayLimit": 1,
        "voucherSharingLimit": 1,
        "voucherAccess": "anonymous",
        "voucherDirectPay": true,
        "voucherTopup": true,
        "voucherAutoTopup": true,
        "voucherActivationEndDate": "text",
        "id": "text",
        "categoryId": "text",
        "taxGroupUid": "text",
        "bomUid": "text",
        "listUids": [
          "text"
        ],
        "comboGroups": [
          {
            "locales": {},
            "min": 1,
            "max": 1,
            "uid": "text",
            "options": [
              {
                "upcharge": 1,
                "selected": true,
                "uid": "text",
                "productUId": "text"
              }
            ]
          }
        ],
        "modifiers": [
          {
            "minSelection": 1,
            "maxSelection": 1,
            "createdAt": "text",
            "createdVia": "text",
            "createdBy": "text",
            "updatedAt": "text",
            "updatedVia": "text",
            "updatedBy": "text",
            "id": "text",
            "options": [
              {
                "defaultQuantity": 1,
                "createdAt": "text",
                "createdVia": "text",
                "createdBy": "text",
                "updatedAt": "text",
                "updatedVia": "text",
                "updatedBy": "text",
                "id": "text"
              }
            ]
          }
        ]
      }
    ],
    "modifiers": [
      {
        "locales": {},
        "minSelection": 1,
        "maxSelection": 1,
        "id": "text",
        "options": [
          {
            "id": "text",
            "locales": {},
            "price": 1,
            "isActive": true,
            "sortNumber": 1,
            "multiple": true,
            "createdAt": "text",
            "createdVia": "text",
            "createdBy": "text",
            "updatedAt": "text",
            "updatedVia": "text",
            "updatedBy": "text",
            "uomAssignmentUid": "text",
            "uomUid": "text",
            "productUid": "text"
          }
        ]
      }
    ],
    "discounts": [
      {
        "locales": {
          "ar": {
            "name": "text",
            "description": "text"
          },
          "en": {
            "name": "text",
            "description": "text"
          }
        },
        "type": "fixed",
        "value": 1,
        "qualifications": [
          "line"
        ],
        "orderTypes": [
          "delivery"
        ],
        "max": 1,
        "isActive": true,
        "excludeTax": true,
        "reasonRequired": true,
        "commentRequired": true,
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text",
        "id": "text",
        "rules": [
          {
            "conditions": [
              {
                "key": "level",
                "operator": "contains",
                "value": "text"
              }
            ],
            "action": "exclude",
            "id": "text"
          }
        ]
      }
    ]
  }
}

Returns the current open order for the specified table.

get

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

tableUidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

400

Functional Error

application/json

get/v1/om/orders/by-table/{tableUid}

HTTPcURLJavaScriptPython

GET /v1/om/orders/by-table/{tableUid} HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "order": {
      "branchUid": "text",
      "businessDate": "text",
      "numberOfGuests": 1,
      "type": "delivery",
      "status": "canceled",
      "closedAt": "text",
      "canceledAt": "text",
      "readyForPickup": true,
      "readyForPickupAt": "text",
      "callNumber": 1,
      "callSource": "text",
      "checkPrintCount": 1,
      "invoicePrintCount": 1,
      "noteToKitchen": "text",
      "internalNote": "text",
      "total": 1,
      "gross": 1,
      "subtotal": 1,
      "tax": 1,
      "totalDiscount": 1,
      "subtotalDiscount": 1,
      "taxDiscount": 1,
      "totalLineDiscounts": 1,
      "balanceDue": 1,
      "prepaidTaxable": 1,
      "prepaidTax": 1,
      "totalPrepaid": 1,
      "appendLoyaltyBenefits": true,
      "shipTo": {
        "building": "text",
        "street": "text",
        "secondary": "text",
        "district": "text",
        "postalCode": "text",
        "city": "text",
        "uid": "text"
      },
      "displayId": "text",
      "source": "text",
      "channelOrderDisplayId": "text",
      "prepareTime": 1,
      "estimatedPickupAt": "text",
      "estimatedDeliveryAt": "text",
      "externalData": {},
      "createdAt": "text",
      "createdVia": "text",
      "createdBy": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "updatedBy": "text",
      "id": "text",
      "uid": "text",
      "fuid": "text",
      "branchId": "text",
      "formattedShortNumber": "text",
      "can": [
        "cancel"
      ],
      "paidAmount": 1,
      "userUid": "text",
      "customerUid": "text",
      "tableUids": [
        "text"
      ],
      "lines": [
        {
          "quantity": 1,
          "note": "text",
          "seats": [
            1
          ],
          "course": 1,
          "status": "Comped",
          "productType": "combo",
          "sentAt": "text",
          "sentPrinting": {},
          "firePrinting": {},
          "voidPrinting": {},
          "lastPrintTime": "text",
          "firedAt": "text",
          "voidedAt": "text",
          "voidReasonId": "text",
          "voidWaste": true,
          "requestedAt": "text",
          "acceptedAt": "text",
          "rejectedAt": "text",
          "rejectReasonId": "text",
          "price": 1,
          "amount": 1,
          "tax": 1,
          "subtotal": 1,
          "taxRate": 1,
          "subtotalDiscounts": 1,
          "taxDiscounts": 1,
          "totalDiscounts": 1,
          "gross": 1,
          "dueAmount": 1,
          "orderDiscountsSubtotal": 1,
          "orderDiscountsTax": 1,
          "orderAppliedDiscounts": [
            {
              "id": "text",
              "amount": 1,
              "subtotal": 1,
              "tax": 1
            }
          ],
          "voucherUid": "text",
          "invoiceId": "text",
          "comboLineId": "text",
          "comboOptionUid": "text",
          "locked": true,
          "lockedBy": "text",
          "lockedAt": "text",
          "createdAt": "text",
          "createdVia": "text",
          "createdBy": "text",
          "updatedAt": "text",
          "updatedVia": "text",
          "updatedBy": "text",
          "id": "text",
          "uid": "text",
          "productUid": "text",
          "uomUid": "text",
          "appliedModifiers": [
            {
              "id": "text",
              "options": [
                {
                  "quantity": 1,
                  "amount": 1,
                  "price": 1,
                  "visible": true,
                  "createdAt": "text",
                  "createdVia": "text",
                  "createdBy": "text",
                  "updatedAt": "text",
                  "updatedVia": "text",
                  "updatedBy": "text",
                  "id": "text",
                  "modifierUid": "text"
                }
              ]
            }
          ],
          "appliedDiscounts": [
            {
              "type": "custom-fixed",
              "value": 1,
              "excludeTax": true,
              "source": "deliverect",
              "sourceId": "text",
              "locales": {},
              "amount": 1,
              "subtotalAmount": 1,
              "taxAmount": 1,
              "reasonId": "text",
              "comment": "text",
              "invoiceId": "text",
              "id": "text"
            }
          ],
          "can": [
            "accept"
          ],
          "subinventoryUid": "text",
          "returns": [
            {
              "quantity": 1,
              "waste": true,
              "invoiceId": "text",
              "reasonId": "text",
              "price": 1,
              "amount": 1,
              "subtotal": 1,
              "tax": 1,
              "gross": 1,
              "createdAt": "text",
              "createdVia": "text",
              "createdBy": "text",
              "updatedAt": "text",
              "updatedVia": "text",
              "updatedBy": "text",
              "id": "text",
              "uid": "text"
            }
          ],
          "returnedQuantity": 1
        }
      ],
      "appliedDiscounts": [
        {
          "type": "custom-fixed",
          "value": 1,
          "excludeTax": true,
          "source": "deliverect",
          "sourceId": "text",
          "locales": {},
          "amount": 1,
          "subtotalAmount": 1,
          "taxAmount": 1,
          "reasonId": "text",
          "comment": "text",
          "invoiceId": "text",
          "id": "text"
        }
      ],
      "payments": [
        {
          "type": "receipt",
          "status": "complete",
          "completedAt": "text",
          "reversedAt": "text",
          "custom": true,
          "amount": 1,
          "sourcePaymentId": "text",
          "transactionRef": "text",
          "attrs": {},
          "invoiceId": "text",
          "note": "text",
          "createdAt": "text",
          "createdVia": "text",
          "createdBy": "text",
          "updatedAt": "text",
          "updatedVia": "text",
          "updatedBy": "text",
          "id": "text",
          "can": [
            "confirm"
          ],
          "methodUid": "text"
        }
      ],
      "invoices": [
        {
          "type": "credit-note",
          "status": "closed",
          "number": 1,
          "source": "text",
          "closedAt": "text",
          "referenceInvoiceId": "text",
          "applyExpiresAt": "text",
          "checkPrintCount": 1,
          "invoicePrintCount": 1,
          "totalDiscount": 1,
          "taxDiscount": 1,
          "subtotalDiscount": 1,
          "subtotal": 1,
          "tax": 1,
          "gross": 1,
          "taxable": 1,
          "total": 1,
          "totalLineDiscounts": 1,
          "prepaidTaxable": 1,
          "prepaidTax": 1,
          "totalPrepaid": 1,
          "balanceDue": 1,
          "id": "text",
          "uid": "text",
          "paidAmount": 1,
          "appliedInvoices": [
            {
              "code": "text",
              "balance": 1,
              "taxableBalance": 1,
              "taxBalance": 1,
              "sourceDate": "text",
              "createdAt": "text",
              "createdVia": "text",
              "createdBy": "text",
              "updatedAt": "text",
              "updatedVia": "text",
              "updatedBy": "text",
              "uid": "text"
            }
          ],
          "appliedDiscounts": [
            {
              "type": "custom-fixed",
              "value": 1,
              "excludeTax": true,
              "source": "deliverect",
              "sourceId": "text",
              "locales": {},
              "amount": 1,
              "subtotalAmount": 1,
              "taxAmount": 1,
              "reasonId": "text",
              "comment": "text",
              "invoiceId": "text",
              "id": "text"
            }
          ],
          "lines": [
            {
              "id": "text",
              "uid": "text",
              "price": 1,
              "amount": 1,
              "dueAmount": 1,
              "tax": 1,
              "subtotal": 1,
              "taxRate": 1,
              "gross": 1,
              "quantity": 1,
              "productUid": "text",
              "subtotalDiscounts": 1,
              "taxDiscounts": 1,
              "totalDiscounts": 1,
              "referenceLineId": "text",
              "status": "Comped",
              "appliedDiscounts": [
                {
                  "type": "custom-fixed",
                  "value": 1,
                  "excludeTax": true,
                  "source": "deliverect",
                  "sourceId": "text",
                  "locales": {},
                  "amount": 1,
                  "subtotalAmount": 1,
                  "taxAmount": 1,
                  "reasonId": "text",
                  "comment": "text",
                  "invoiceId": "text",
                  "id": "text"
                }
              ]
            }
          ],
          "can": [
            "close"
          ]
        }
      ],
      "alerts": [
        {
          "type": "order-not-sent"
        }
      ],
      "channelUid": "text",
      "externalId": "text",
      "estimatedReadyAt": "text",
      "sessionUid": "text"
    },
    "user": {},
    "customer": {},
    "tables": [
      {
        "name": "text",
        "x": 1,
        "y": 1,
        "width": 1,
        "height": 1,
        "circle": true,
        "minSeats": 1,
        "maxSeats": 1,
        "archived": true,
        "id": "text",
        "areaId": "text"
      }
    ],
    "areas": [
      {
        "locales": {},
        "backgroundImage": "text",
        "id": "text",
        "branchId": "text"
      }
    ],
    "paymentMethods": [
      {
        "locales": {
          "ar": {
            "name": "text",
            "description": "text"
          },
          "en": {
            "name": "text",
            "description": "text"
          }
        },
        "visible": true,
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text",
        "id": "text"
      }
    ],
    "products": [
      {
        "image": "text",
        "price": 1,
        "locales": {},
        "calories": 1,
        "sort": 1,
        "allergies": [
          "text"
        ],
        "active": true,
        "posImageUrl": "text",
        "type": "combo",
        "sku": "text",
        "inventory": true,
        "primaryUomUid": "text",
        "voucherValidaty": 1,
        "voucherPayLimit": 1,
        "voucherSharingLimit": 1,
        "voucherAccess": "anonymous",
        "voucherDirectPay": true,
        "voucherTopup": true,
        "voucherAutoTopup": true,
        "voucherActivationEndDate": "text",
        "id": "text",
        "categoryId": "text",
        "taxGroupUid": "text",
        "bomUid": "text",
        "listUids": [
          "text"
        ],
        "comboGroups": [
          {
            "locales": {},
            "min": 1,
            "max": 1,
            "uid": "text",
            "options": [
              {
                "upcharge": 1,
                "selected": true,
                "uid": "text",
                "productUId": "text"
              }
            ]
          }
        ],
        "modifiers": [
          {
            "minSelection": 1,
            "maxSelection": 1,
            "createdAt": "text",
            "createdVia": "text",
            "createdBy": "text",
            "updatedAt": "text",
            "updatedVia": "text",
            "updatedBy": "text",
            "id": "text",
            "options": [
              {
                "defaultQuantity": 1,
                "createdAt": "text",
                "createdVia": "text",
                "createdBy": "text",
                "updatedAt": "text",
                "updatedVia": "text",
                "updatedBy": "text",
                "id": "text"
              }
            ]
          }
        ]
      }
    ],
    "modifiers": [
      {
        "locales": {},
        "minSelection": 1,
        "maxSelection": 1,
        "id": "text",
        "options": [
          {
            "id": "text",
            "locales": {},
            "price": 1,
            "isActive": true,
            "sortNumber": 1,
            "multiple": true,
            "createdAt": "text",
            "createdVia": "text",
            "createdBy": "text",
            "updatedAt": "text",
            "updatedVia": "text",
            "updatedBy": "text",
            "uomAssignmentUid": "text",
            "uomUid": "text",
            "productUid": "text"
          }
        ]
      }
    ],
    "discounts": [
      {
        "locales": {
          "ar": {
            "name": "text",
            "description": "text"
          },
          "en": {
            "name": "text",
            "description": "text"
          }
        },
        "type": "fixed",
        "value": 1,
        "qualifications": [
          "line"
        ],
        "orderTypes": [
          "delivery"
        ],
        "max": 1,
        "isActive": true,
        "excludeTax": true,
        "reasonRequired": true,
        "commentRequired": true,
        "createdAt": "text",
        "createdVia": "text",
        "createdBy": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "updatedBy": "text",
        "id": "text",
        "rules": [
          {
            "conditions": [
              {
                "key": "level",
                "operator": "contains",
                "value": "text"
              }
            ],
            "action": "exclude",
            "id": "text"
          }
        ]
      }
    ]
  }
}