--- updatedAt: 2025-05-27T12:39:21.000Z --- Fetch the complete documentation index at: https://developers.flipdish.com/v1.0/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version. # /api/v1.0/orders # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "version": "v1.0", "title": "Flipdish Open API v1.0" }, "paths": { "/api/v1.0/orders": { "get": { "tags": [ "Orders" ], "operationId": "GetOrders", "parameters": [ { "name": "physicalRestaurantId", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "state", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "Created", "PlacedCanBeCancelled", "ReadyToProcess", "AcceptedByRestaurant", "Dispatched", "Delivered", "Cancelled", "ManualReview", "RejectedByStore", "RejectedByFlipdish", "RejectedAutomatically", "RejectedAfterBeingAccepted", "AcceptedAndRefunded" ] } } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiPaginationResult-Order" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RestApiPaginationResult-Order" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RestApiPaginationResult-Order" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RestApiPaginationResult-Order" } }, "Data": { "examples": { "response": { "value": [ { "Store": { "Id": 123, "Name": "Restaurant", "MenuId": 123, "Metadata": { "foo": "bar" }, "Currency": "EUR", "Coordinates": { "Latitude": 53.3421247, "Longitude": -6.2615012 }, "StoreGroupId": 0 }, "Customer": { "Id": 1234, "Name": "John Doe", "EmailAddress": "john@doe.com", "PhoneNumberLocalFormat": "0818204488", "PhoneNumber": "+353818204488" }, "Voucher": { "VoucherId": 123, "Name": "-€5 (abc123)", "Description": "abc123", "Code": "abc123", "Amount": 5, "Type": "PercentageDiscount", "SubType": "None" }, "Fees": { "FeeAmount": 0, "PercentageRate": 0, "PerTransactionFee": 0 }, "OrderItems": [ { "OrderItemOptions": [ { "Metadata": { "foo": "bar" }, "MenuItemOptionPublicId": "064bcf90-6679-4e75-9262-13c066c3fb36", "MenuItemOptionId": 654645, "IsMasterOptionSetItem": false, "Name": "Option 1", "Price": 1, "MenuItemOptionDisplayOrder": 1, "MenuItemOptionSetDisplayOrder": 1 } ], "Metadata": { "foo": "bar" }, "MenuItemPublicId": "064bcf90-6679-4e75-9262-13c066c3fb36", "MenuSectionName": "Section 1", "MenuSectionDisplayOrder": 1, "Name": "Item 1", "Description": "First order item", "Price": 19, "PriceIncludingOptionSetItems": 20, "MenuItemId": 5545, "MenuItemDisplayOrder": 1, "IsAvailable": true } ], "DeliveryLocation": { "Coordinates": { "Latitude": 53.3421247, "Longitude": -6.2615012 }, "Building": "38", "Street": "Pearse Street", "Town": "Dublin", "PostCode": "xx xxx", "DeliveryInstructions": "building is on the right", "PrettyAddressString": "38 Parse Street, Dublin, xx xxx" }, "CustomerLocation": { "Latitude": 53.3421247, "Longitude": -6.2615012 }, "MaskedPhoneNumber": { "IsEnabled": false }, "AcceptedFor": "2020-02-24T18:45:00", "InFraudZone": false, "UnusualHighValueOrder": false, "Channel": { "ChannelId": 0, "TranslationKey": "Google", "Source": "Internal", "LogoUri": "https://cdn.flipdish.com/logo.png", "Available": true, "MaintainedExternally": false }, "OrderDropOffLocation": { "OrderId": 0, "LocationId": 0, "LocationAreaId": 0 }, "FulfillmentStatus": { "StatusId": "preparing", "StatusName": "Preparing", "Icon": "https://flipdish.com/icons/123.png" }, "OrderBatchInfo": { "Id": 0, "CreateTime": "0001-01-01T00:00:00", "IsPublished": false }, "OrderId": 1234, "LocalOrderId": "A152", "DeliveryType": "Delivery", "PickupLocationType": "TakeOut", "TableServiceCatagory": "Gate", "TipAmount": 1, "DeliveryAmount": 2, "OrderItemsAmount": 20, "ServiceChargeAmount": 0, "ServiceChargePercentage": 0, "Amount": 20, "ProcessingFee": 0.5, "PaymentAccountType": "Card", "PaymentAccountDescription": "Visa ****2371", "OrderState": "ReadyToProcess", "IsPreOrder": true, "PlacedTime": "2017-12-15T11:00:00", "RequestedForTime": "2017-12-15T12:00:00", "ChefNote": "no oregano please", "AppType": "Ios", "UserRating": 2, "PaymentStatus": "Refunded", "RejectionReason": "TooBusy", "DeliveryTrackingStatus": "OnTheWay", "TotalTax": 0 } ] } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiErrorResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RestApiErrorResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RestApiErrorResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RestApiErrorResult" } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiUnauthorizedResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RestApiUnauthorizedResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RestApiUnauthorizedResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RestApiUnauthorizedResult" } }, "Message": { "examples": { "response": { "value": "Authentication has been denied for this request." } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiForbiddenResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RestApiForbiddenResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RestApiForbiddenResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/RestApiForbiddenResult" } }, "Message": { "examples": { "response": { "value": "Successful authentication, but authorization has been denied for this request." } } } } } }, "security": [ { "oauth2": [ "api" ] } ] } } }, "x-samples-languages": [ "curl", "node", "csharp", "ruby", "javascript", "python", "swift" ], "x-send-defaults": true, "x-flipdish-signalr": [ { "hubName": "AnalyticsHub", "events": [ { "eventName": "analytics.website", "eventType": "AnalyticsClientEvent" } ] }, { "hubName": "AppHub", "events": [ { "eventName": "app.created", "eventType": "AppCreatedEvent" }, { "eventName": "app.updated", "eventType": "AppUpdatedEvent" } ] }, { "hubName": "AuthorizationHub", "events": [] }, { "hubName": "BankAccountHub", "events": [ { "eventName": "bankaccount.created", "eventType": "BankAccountCreatedEvent" }, { "eventName": "bankaccount.updated", "eventType": "BankAccountUpdatedEvent" }, { "eventName": "bankaccount.deleted", "eventType": "BankAccountDeletedEvent" } ] }, { "hubName": "CampaignHub", "events": [] }, { "hubName": "CardReaderHub", "events": [ { "eventName": "cardreaders.kiosk.bluetooth.initiatepairingmode", "eventType": "KioskBluetoothPairingModeEvent" }, { "eventName": "cardreaders.kiosk.bluetooth.unpaired", "eventType": "KioskBluetoothTerminalUnpairedEvent" }, { "eventName": "cardreaders.kiosk.bluetooth.updated", "eventType": "KioskBluetoothTerminalUpdatedEvent" }, { "eventName": "cardreaders.kiosk.bluetooth.checkforupdates", "eventType": "KioskBluetoothTerminalInitiateUpdateCheckEvent" }, { "eventName": "cardreaders.kiosk.bluetooth.initiateinstallupdatemode", "eventType": "KioskBluetoothInstallUpdateInitiateEvent" }, { "eventName": "cardreaders.kiosk.bluetooth.cancelupdateinstall", "eventType": "KioskBluetoothTerminalCancelUpdateEvent" }, { "eventName": "cardreaders.kiosk.bluetooth.installationstatus", "eventType": "KioskBluetoothTerminalInstallationStatusEvent" }, { "eventName": "cardreaders.kiosk.bluetooth.firmwareupdateversion", "eventType": "KioskBluetoothTerminalFirmwareVersionStatusEvent" }, { "eventName": "cardreaders.kiosk.bluetooth.terminalactionstatechanged", "eventType": "KioskTerminalActionStateChangedEvent" } ] }, { "hubName": "ChannelHub", "events": [] }, { "hubName": "CustomerHub", "events": [ { "eventName": "customer.created", "eventType": "CustomerCreatedEvent" }, { "eventName": "customer.updated", "eventType": "CustomerUpdatedEvent" }, { "eventName": "customer.consent.updated", "eventType": "CustomerConsentUpdatedEvent" } ] }, { "hubName": "HydraHub", "events": [ { "eventName": "hydra.assigned", "eventType": "HydraAssignedEvent" }, { "eventName": "hydra.request_reset", "eventType": "HydraRequestResetEvent" }, { "eventName": "hydra.setting_changed", "eventType": "HydraSettingChangedEvent" }, { "eventName": "hydra.conection_status_changed", "eventType": "HydraConnectionStatusChangedEvent" }, { "eventName": "hydra.unassigned", "eventType": "HydraUnAssignedEvent" }, { "eventName": "hydra.store.assigned", "eventType": "HydraStoreAssignedEvent" }, { "eventName": "hydra.store.unassigned", "eventType": "HydraStoreUnassignedEvent" } ] }, { "hubName": "MenuCheckpointHub", "events": [] }, { "hubName": "MenuHub", "events": [] }, { "hubName": "OrderHub", "events": [ { "eventName": "order.created", "eventType": "OrderCreatedEvent" }, { "eventName": "order.rejected", "eventType": "OrderRejectedEvent" }, { "eventName": "order.accepted", "eventType": "OrderAcceptedEvent" }, { "eventName": "order.refunded", "eventType": "OrderRefundedEvent" } ] }, { "hubName": "PhoneCallHub", "events": [] }, { "hubName": "PrinterHub", "events": [] }, { "hubName": "StoreGroupHub", "events": [ { "eventName": "store_group.created", "eventType": "StoreGroupCreatedEvent" }, { "eventName": "store_group.updated", "eventType": "StoreGroupUpdatedEvent" }, { "eventName": "store_group.deleted", "eventType": "StoreGroupDeletedEvent" } ] }, { "hubName": "StoreHub", "events": [ { "eventName": "store.created", "eventType": "StoreCreatedEvent" }, { "eventName": "store.updated", "eventType": "StoreUpdatedEvent" }, { "eventName": "store.archived", "eventType": "StoreArchivedEvent" }, { "eventName": "store.unarchived", "eventType": "StoreUnarchivedEvent" }, { "eventName": "store.published", "eventType": "StorePublishedEvent" }, { "eventName": "store.unpublished", "eventType": "StoreUnpublishedEvent" }, { "eventName": "store.deleted", "eventType": "StoreDeletedEvent" }, { "eventName": "store.address.updated", "eventType": "StoreAddressUpdatedEvent" }, { "eventName": "store.opening_hours.updated", "eventType": "StoreOpeningHoursUpdatedEvent" }, { "eventName": "store.menu.assigned", "eventType": "StoreMenuAssignedEvent" }, { "eventName": "store.delivery_zone.created", "eventType": "DeliveryZoneCreatedEvent" }, { "eventName": "store.delivery_zone.updated", "eventType": "DeliveryZoneUpdatedEvent" }, { "eventName": "store.delivery_zone.deleted", "eventType": "DeliveryZoneDeletedEvent" }, { "eventName": "store_group.created", "eventType": "StoreGroupCreatedEvent" }, { "eventName": "store_group.updated", "eventType": "StoreGroupUpdatedEvent" }, { "eventName": "store_group.deleted", "eventType": "StoreGroupDeletedEvent" }, { "eventName": "store.business_hours_override.created", "eventType": "StoreBusinessHoursOverrideCreatedEvent" }, { "eventName": "store.business_hours_override.deleted", "eventType": "StoreBusinessHoursOverrideDeletedEvent" }, { "eventName": "store.preorder_config.updated", "eventType": "StorePreOrderConfigUpdatedEvent" }, { "eventName": "store.logo.created", "eventType": "StoreLogoCreatedEvent" }, { "eventName": "store.logo.updated", "eventType": "StoreLogoUpdatedEvent" }, { "eventName": "store.logo.deleted", "eventType": "StoreLogoDeletedEvent" }, { "eventName": "store.kiosk_setting.updated", "eventType": "StoreKioskSettingUpdatedEvent" }, { "eventName": "store.fee_config.updated", "eventType": "StoreFeeConfigUpdatedEvent" } ] }, { "hubName": "TeammateHub", "events": [ { "eventName": "teammate.invite.sent", "eventType": "TeammateInviteSentEvent" }, { "eventName": "teammate.invite.accepted", "eventType": "TeammateInviteAcceptedEvent" }, { "eventName": "teammate.updated", "eventType": "TeammateUpdatedEvent" }, { "eventName": "teammate.deleted", "eventType": "TeammateDeletedEvent" } ] }, { "hubName": "TelephonyConfigHub", "events": [] }, { "hubName": "VoucherHub", "events": [ { "eventName": "voucher.created", "eventType": "VoucherCreatedEvent" }, { "eventName": "voucher.deleted", "eventType": "VoucherDeletedEvent" }, { "eventName": "voucher.updated", "eventType": "VoucherUpdatedEvent" }, { "eventName": "voucher.applied", "eventType": "VoucherAppliedEvent" } ] }, { "hubName": "WebhookHub", "events": [] }, { "hubName": "WebsiteHub", "events": [] } ], "servers": [ { "url": "https://api.flipdish.co" } ], "components": { "securitySchemes": { "oauth2": { "type": "oauth2", "description": "OAuth2 Implicit Grant", "flows": { "implicit": { "authorizationUrl": "https://api.flipdish.co/identity/connect/authorize", "scopes": { "api": "Access to Flipdish API" } } } } }, "schemas": { "RestApiErrorResult": { "description": "Rest api error result", "required": [ "Message" ], "type": "object", "properties": { "Message": { "description": "Error message", "type": "string" }, "ErrorCode": { "format": "int32", "description": "Error code", "type": "integer" }, "StackTrace": { "description": "Stack trace", "type": "string" }, "Errors": { "description": "List of errors grouped by field name", "type": "array", "items": { "$ref": "#/components/schemas/ValidationErrorResult" } } } }, "ValidationErrorResult": { "description": "Validation error result", "type": "object", "properties": { "FieldName": { "description": "Field name", "type": "string" }, "Errors": { "description": "List of errors relates to field", "type": "array", "items": { "type": "string" } } } }, "RestApiUnauthorizedResult": { "description": "Rest api unauthorized result", "required": [ "Message" ], "type": "object", "properties": { "Message": { "description": "Message", "type": "string", "readOnly": true } } }, "RestApiForbiddenResult": { "description": "Rest Api Forbidden Result", "required": [ "Message" ], "type": "object", "properties": { "Message": { "description": "Message", "type": "string", "readOnly": true } } }, "Coordinates": { "description": "Coordinates", "type": "object", "properties": { "Latitude": { "format": "double", "description": "Latitude", "type": "number" }, "Longitude": { "format": "double", "description": "Longitude", "type": "number" } } }, "Channel": { "type": "object", "properties": { "ChannelId": { "format": "int32", "description": "Channel Id", "type": "integer" }, "TranslationKey": { "description": "Channel TranslationKey", "type": "string" }, "Source": { "description": "Channel Source", "enum": [ "Internal", "External" ], "type": "string" }, "LogoUri": { "description": "Channel Logo URl", "type": "string" }, "Available": { "description": "Channel is Available or not", "type": "boolean" }, "MaintainedExternally": { "description": "Channel is Maintained Externally or not", "type": "boolean" } } }, "Order": { "description": "Order", "type": "object", "properties": { "Store": { "$ref": "#/components/schemas/StoreSummary" }, "Customer": { "$ref": "#/components/schemas/CustomerSummary" }, "Voucher": { "$ref": "#/components/schemas/OrderVoucherSummary" }, "Fees": { "$ref": "#/components/schemas/FeeSummary" }, "OrderItems": { "description": "Ordered items", "type": "array", "items": { "$ref": "#/components/schemas/OrderItem" } }, "DeliveryLocation": { "$ref": "#/components/schemas/DeliveryLocation" }, "CustomerLocation": { "$ref": "#/components/schemas/Coordinates" }, "MaskedPhoneNumber": { "$ref": "#/components/schemas/MaskedPhoneNumber" }, "DropOffLocationId": { "format": "int32", "description": "Represents table service drop off location", "type": "integer", "nullable": true }, "DropOffLocation": { "description": "Represents table service drop off location", "type": "string" }, "AcceptedFor": { "format": "date-time", "description": "Time store has accepted the order for", "type": "string", "nullable": true }, "InFraudZone": { "description": "Was order made within a fraud zone", "type": "boolean" }, "UnusualHighValueOrder": { "description": "Is order of unusually high value", "type": "boolean" }, "RejectedByUserId": { "format": "int32", "description": "Id of user who rejected order, if available", "type": "integer", "nullable": true }, "ChannelOrderId": { "description": "ChannelOrderId from external channel", "type": "string" }, "ChannelOrderDisplayId": { "description": "ChannelOrderDisplayId from external channel", "type": "string" }, "Channel": { "$ref": "#/components/schemas/Channel" }, "OrderDropOffLocation": { "$ref": "#/components/schemas/OrderDropOffLocation" }, "FulfillmentStatus": { "$ref": "#/components/schemas/OrderFulfillmentStatusBase" }, "OrderBatchInfo": { "$ref": "#/components/schemas/OrderBatchSummary" }, "CreatedCampaignVoucherId": { "format": "int32", "description": "The id of the campaign voucher that was created from this order", "type": "integer", "nullable": true }, "OrderId": { "format": "int32", "description": "Order identifier", "type": "integer" }, "LocalOrderId": { "description": "Local order Id. This is used for displaying a \"shorter\" order ID for customers (eg. Kiosk orders)", "type": "string" }, "DeliveryType": { "description": "Delivery type", "enum": [ "Delivery", "Pickup" ], "type": "string" }, "PickupLocationType": { "description": "Pickup location type", "enum": [ "TakeOut", "TableService", "DineIn" ], "type": "string" }, "TableServiceCatagory": { "description": "Pickup location type", "enum": [ "Generic", "Villa", "House", "Room", "Area", "Table", "ParkingBay", "Gate", "DriveThrough", "Team" ], "type": "string", "nullable": true }, "TipAmount": { "format": "double", "description": "Tip amount", "type": "number" }, "DeliveryAmount": { "format": "double", "description": "Delivery amount", "type": "number" }, "OrderItemsAmount": { "format": "double", "description": "Ordered items amount", "type": "number" }, "ServiceChargeAmount": { "format": "double", "description": "Service Charge Amount", "type": "number" }, "ServiceChargePercentage": { "format": "double", "description": "Service Charge Percentage", "type": "number" }, "Amount": { "format": "double", "description": "This is the sum of the OrderItemsAmount, DeliveryAmount, TipAmount and Voucher.Amount (which is usually negative) and OnlineOrderingFee for cash orders.\r\nIt does not include the OnlineOrderingFee in the case of card orders as this fee is charged by Flipdish directly to the customer.", "type": "number" }, "ProcessingFee": { "format": "double", "description": "This contains the online ordering processing fee. For card payments this is charged directly to the customer and for cash orders it is paid by the customer to the store. It is tax inclusive.", "type": "number" }, "PaymentAccountType": { "description": "Payment account type", "enum": [ "Card", "Cash", "Ideal", "Bancontact", "Giropay", "Eps", "Emv", "PayPal", "PayGreen", "GoogleWalletToken" ], "type": "string" }, "PaymentAccountDescription": { "description": "Payment account description (like Visa ****2371 or Apple Pay. or Cash)", "type": "string" }, "OrderState": { "description": "Order state", "enum": [ "Created", "PlacedCanBeCancelled", "ReadyToProcess", "AcceptedByRestaurant", "Dispatched", "Delivered", "Cancelled", "ManualReview", "RejectedByStore", "RejectedByFlipdish", "RejectedAutomatically", "RejectedAfterBeingAccepted", "AcceptedAndRefunded" ], "type": "string" }, "IsPreOrder": { "description": "Is pre-order", "type": "boolean" }, "PlacedTime": { "format": "date-time", "description": "Order placed time", "type": "string" }, "RequestedForTime": { "format": "date-time", "description": "Order requested for", "type": "string" }, "ChefNote": { "description": "Chef note", "type": "string" }, "AppType": { "description": "Used app type", "enum": [ "Unknown", "Ios", "Android", "Web", "Kiosk", "Pos", "TelephoneCall", "Sms", "PwaAndroid", "PwaIos", "Google" ], "type": "string" }, "UserRating": { "format": "int32", "description": "User rating", "type": "integer", "nullable": true }, "PaymentStatus": { "description": "Status of the payment", "enum": [ "Paid", "Unpaid", "Refunded", "PartiallyRefunded", "Disputed" ], "type": "string" }, "RejectionReason": { "description": "Rejection reason. Can have value if the order is rejected.", "enum": [ "TooBusy", "FoodUnavailable", "UnableToDeliver", "UnknownAddress", "UnknownReason", "TooSoon", "TimeUnavailable", "DontDeliverToArea", "StoreUncontactable" ], "type": "string", "nullable": true }, "RefundedAmount": { "format": "double", "description": "Amount refunded to customer.", "type": "number", "nullable": true }, "DeliveryTrackingStatus": { "description": "Delivery tracking status", "enum": [ "Unassigned", "Unaccepted", "Accepted", "Carrying", "OnTheWay", "ArrivedAtLocation", "Delivered", "CannotDeliver" ], "type": "string", "nullable": true }, "DriverId": { "format": "int32", "description": "Assigned driver identifier", "type": "integer", "nullable": true }, "TotalTax": { "format": "double", "description": "Total tax applied to order", "type": "number" }, "OrderTrackingCode": { "description": "Unique, 6 character long alpha numeric code for tracking.", "type": "string" }, "DeliveryFeeAreaId": { "format": "int32", "description": "Delivery area identifier", "type": "integer", "nullable": true }, "ReceiptCode": { "description": "Code used to view the order's receipt", "type": "string" } } }, "StoreSummary": { "description": "Store summary", "type": "object", "properties": { "Id": { "format": "int32", "description": "Store identifier", "type": "integer" }, "Name": { "description": "Store name", "type": "string" }, "MenuId": { "format": "int32", "description": "Stores menu identifier", "type": "integer" }, "Metadata": { "description": "Store metadata", "type": "object", "additionalProperties": { "type": "string" } }, "Currency": { "description": "Currency which used by the Store", "enum": [ "EUR", "USD", "GBP", "CAD", "AUD", "DJF", "ZAR", "ETB", "AED", "BHD", "DZD", "EGP", "IQD", "JOD", "KWD", "LBP", "LYD", "MAD", "OMR", "QAR", "SAR", "SYP", "TND", "YER", "CLP", "INR", "AZN", "RUB", "BYN", "BGN", "NGN", "BDT", "CNY", "BAM", "CZK", "DKK", "CHF", "MVR", "BTN", "XCD", "BZD", "HKD", "IDR", "JMD", "MYR", "NZD", "PHP", "SGD", "TTD", "XDR", "ARS", "BOB", "COP", "CRC", "CUP", "DOP", "GTQ", "HNL", "MXN", "NIO", "PAB", "PEN", "PYG", "UYU", "VEF", "IRR", "XOF", "CDF", "XAF", "HTG", "ILS", "HRK", "HUF", "AMD", "ISK", "JPY", "GEL", "KZT", "KHR", "KRW", "KGS", "LAK", "MKD", "MNT", "BND", "MMK", "NOK", "NPR", "PKR", "PLN", "AFN", "BRL", "MDL", "RON", "RWF", "SEK", "LKR", "SOS", "ALL", "RSD", "KES", "TJS", "THB", "ERN", "TMT", "BWP", "TRY", "UAH", "UZS", "VND", "MOP", "TWD", "BMD" ], "type": "string" }, "Coordinates": { "$ref": "#/components/schemas/Coordinates" }, "StoreTimezone": { "description": "Timezone of store", "type": "string" }, "StoreGroupId": { "format": "int32", "description": "Store group id of store", "type": "integer" } } }, "CustomerSummary": { "description": "Customer summary", "type": "object", "properties": { "Id": { "format": "int32", "description": "Customer identifier", "type": "integer" }, "Name": { "description": "Customer name", "type": "string" }, "EmailAddress": { "description": "Customer email address", "type": "string" }, "PhoneNumberLocalFormat": { "description": "Customer local phone number", "type": "string" }, "PhoneNumber": { "description": "Customer phone number", "type": "string" } } }, "OrderVoucherSummary": { "description": "Voucher summary", "type": "object", "properties": { "VoucherId": { "format": "int32", "description": "Voucher ID", "type": "integer" }, "Name": { "description": "Voucher name", "type": "string" }, "Description": { "description": "Voucher description", "type": "string" }, "Code": { "description": "Voucher code", "type": "string" }, "Amount": { "format": "double", "description": "Voucher amount", "type": "number" }, "Type": { "description": "Voucher type", "enum": [ "PercentageDiscount", "LumpDiscount", "AddItem", "CreditNote", "FreeDelivery" ], "type": "string" }, "SubType": { "description": "Voucher sub type", "enum": [ "None", "SignUp", "Loyalty", "Loyalty25", "Retention", "SecondaryRetention", "Custom" ], "type": "string" } } }, "FeeSummary": { "description": "Fee Summary", "type": "object", "properties": { "FeeAmount": { "format": "double", "description": "Fee amount", "type": "number" }, "PercentageRate": { "format": "double", "description": "Percentage rate", "type": "number" }, "PerTransactionFee": { "format": "double", "description": "Per transaction fee", "type": "number" } } }, "OrderItem": { "description": "Order item", "type": "object", "properties": { "OrderItemOptions": { "description": "Option list", "type": "array", "items": { "$ref": "#/components/schemas/OrderItemOption" } }, "Metadata": { "description": "Metadata", "type": "object", "additionalProperties": { "type": "string" } }, "MenuItemPublicId": { "format": "uuid", "description": "Public id of the Menu Item", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "MenuSectionName": { "description": "Menu section name", "type": "string" }, "MenuSectionDisplayOrder": { "format": "int32", "description": "Menu section display order", "type": "integer" }, "Name": { "description": "Name", "type": "string" }, "Description": { "description": "Description", "type": "string" }, "Price": { "format": "double", "description": "Price", "type": "number" }, "PriceIncludingOptionSetItems": { "format": "double", "description": "Price including option set items", "type": "number" }, "MenuItemId": { "format": "int32", "description": "Menu item identifier", "type": "integer" }, "MenuItemDisplayOrder": { "format": "int32", "description": "Menu item display order", "type": "integer" }, "IsAvailable": { "description": "Is available", "type": "boolean" }, "DepositReturnFee": { "format": "double", "description": "Deposit return fee", "type": "number", "nullable": true } } }, "DeliveryLocation": { "description": "Delivery location", "type": "object", "properties": { "Coordinates": { "$ref": "#/components/schemas/Coordinates" }, "Building": { "description": "Building", "type": "string" }, "Street": { "description": "Street", "type": "string" }, "Town": { "description": "Town", "type": "string" }, "PostCode": { "description": "Post code", "type": "string" }, "DeliveryInstructions": { "description": "Delivery instructions", "type": "string" }, "PrettyAddressString": { "description": "Formatted, pretty address string", "type": "string" } } }, "MaskedPhoneNumber": { "description": "Represents a masked phone number", "type": "object", "properties": { "IsEnabled": { "description": "Defines if the feature is enabled", "type": "boolean" }, "PhoneNumber": { "description": "Defines the phone number to call", "type": "string" }, "Code": { "description": "Defines the code to enter", "type": "string" } } }, "OrderDropOffLocation": { "type": "object", "properties": { "OrderId": { "format": "int32", "type": "integer" }, "LocationName": { "type": "string" }, "LocationAreaName": { "type": "string" }, "LocationId": { "format": "int32", "type": "integer" }, "LocationAreaId": { "format": "int32", "type": "integer" }, "ExternalLocationId": { "type": "string" } } }, "OrderFulfillmentStatusBase": { "description": "Fulfillment Status Information", "type": "object", "properties": { "StatusId": { "description": "Fulfillment Status Id", "type": "string" }, "StatusName": { "description": "Fulfillment Status Name", "type": "string" }, "Icon": { "description": "Status Icon", "type": "string" } } }, "OrderBatchSummary": { "description": "Order batch info", "type": "object", "properties": { "Id": { "format": "int32", "description": "Order batch id", "type": "integer" }, "DisplayCode": { "description": "Order batch 6-sign human readable code", "type": "string" }, "CreateTime": { "format": "date-time", "description": "Batch creation date and time", "type": "string" }, "IsPublished": { "description": "If the batch is already published", "type": "boolean" } } }, "OrderItemOption": { "description": "Order item option", "type": "object", "properties": { "Metadata": { "description": "Metadata", "type": "object", "additionalProperties": { "type": "string" } }, "MenuItemOptionPublicId": { "format": "uuid", "description": "Public id of the Menu Item Option", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "MenuItemOptionId": { "format": "int32", "description": "Menu item option identifier", "type": "integer" }, "IsMasterOptionSetItem": { "description": "Is master option set item", "type": "boolean" }, "Name": { "description": "Name", "type": "string" }, "Price": { "format": "double", "description": "Price", "type": "number" }, "MenuItemOptionDisplayOrder": { "format": "int32", "description": "Menu item option display order", "type": "integer" }, "MenuItemOptionSetDisplayOrder": { "format": "int32", "description": "Menu item option set display order", "type": "integer" }, "DepositReturnFee": { "format": "double", "description": "Deposit return fee", "type": "number", "nullable": true } } }, "RestApiPaginationResult-Order": { "description": "Rest api pagination result", "required": [ "Page", "Limit", "TotalRecordCount", "Data" ], "type": "object", "properties": { "Page": { "format": "int32", "description": "Current page index", "type": "integer" }, "Limit": { "format": "int32", "description": "Current page size", "type": "integer" }, "TotalRecordCount": { "format": "int32", "description": "Total record count", "type": "integer" }, "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/Order" } } } } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```