---
title: "GET /api/v1.0/orders"
method: GET
path: "/api/v1.0/orders"
tags: ["Orders"]
---

# GET /api/v1.0/orders

`GET /api/v1.0/orders`

## Query parameters

- `physicalRestaurantId` integer[]
- `state` string[]
- `from` string, date-time
- `to` string, date-time
- `page` integer
- `limit` integer

## Response `200`

OK

- RestApiPaginationResultOrder — Rest api pagination result
  - `Page` integer, required — Current page index
  - `Limit` integer, required — Current page size
  - `TotalRecordCount` integer, required — Total record count
  - `Data` Order[], required — Generic data object.
    - `Store` StoreSummary — Store summary
      - `Id` integer — Store identifier
      - `Name` string — Store name
      - `MenuId` integer — Stores menu identifier
      - `MenuPublishId` string, uuid — Stores menu publish GUID
      - `Metadata` object — Store metadata
      - `Currency` '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' — Currency which used by the Store
      - `Coordinates` Coordinates — Coordinates
        - `Latitude` number, double — Latitude
        - `Longitude` number, double — Longitude
      - `StoreTimezone` string — Timezone of store
      - `StoreIanaTimezone` string — IANA Timezone of store
      - `StoreGroupId` integer — Store group id of store
      - `TaxId` string — VAT number or generic Tax ID of the store
      - `PrettyAddress` string — Address of the store
      - `CountryCode` string — Country code of the store address (ISO 3166-1 alpha-2)
      - `PropertyId` string — Property identifier
    - `Customer` CustomerSummary — Customer summary
      - `Id` integer — Customer identifier
      - `Name` string — Customer name
      - `EmailAddress` string — Customer email address
      - `PhoneNumberLocalFormat` string — Customer local phone number
      - `PhoneNumber` string — Customer phone number
      - `LanguagePreference` string — Preferred language of the consumer
    - `Voucher` OrderVoucherSummary — Voucher summary
      - `VoucherId` integer — Voucher ID
      - `Name` string — Voucher name
      - `Description` string — Voucher description
      - `Code` string — Voucher code
      - `Amount` number, double — Voucher amount
      - `Type` 'PercentageDiscount' | 'LumpDiscount' | 'AddItem' | 'CreditNote' | 'FreeDelivery' — Voucher type
      - `SubType` 'None' | 'SignUp' | 'Loyalty' | 'Loyalty25' | 'Retention' | 'SecondaryRetention' | 'Custom' — Voucher sub type
    - `Fees` FeeSummary — Fee Summary
      - `FeeAmount` number, double — Fee amount
      - `PercentageRate` number, double — Percentage rate
      - `PerTransactionFee` number, double — Per transaction fee
    - `OrderItems` OrderItem[] — Ordered items
      - `OrderItemOptions` OrderItemOption[] — Option list
        - `Metadata` object — Metadata
        - `MenuItemOptionPublicId` string, uuid — Public id of the Menu Item Option
        - `MenuItemOptionId` integer — Menu item option identifier
        - `IsMasterOptionSetItem` boolean — Is master option set item
        - `Name` string — Name
        - `Price` number, double — Price
        - `TaxAmount` number, double — Tax currency amount
        - `MenuItemOptionDisplayOrder` integer — Menu item option display order
        - `MenuItemOptionSetDisplayOrder` integer — Menu item option set display order
        - `DepositReturnFee` number, double, nullable — Deposit return fee
      - `Metadata` object — Metadata
      - `MenuItemPublicId` string, uuid — Public id of the Menu Item
      - `MenuSectionName` string — Menu section name
      - `MenuSectionDisplayOrder` integer — Menu section display order
      - `Name` string — Name
      - `Description` string — Description
      - `Price` number, double — Price
      - `TaxAmount` number, double — Tax currency amount
      - `PriceIncludingOptionSetItems` number, double — Price including option set items
      - `MenuItemId` integer — Menu item identifier
      - `MenuItemDisplayOrder` integer — Menu item display order
      - `IsAvailable` boolean — Is available
      - `DepositReturnFee` number, double, nullable — Deposit return fee
    - `DeliveryLocation` DeliveryLocation — Delivery location
      - `Coordinates` Coordinates — Coordinates
        - `Latitude` number, double — Latitude
        - `Longitude` number, double — Longitude
      - `Building` string — Building
      - `Street` string — Street
      - `Town` string — Town
      - `PostCode` string — Post code
      - `DeliveryInstructions` string — Delivery instructions
      - `PrettyAddressString` string — Formatted, pretty address string
    - `CustomerLocation` Coordinates — Coordinates
      - `Latitude` number, double — Latitude
      - `Longitude` number, double — Longitude
    - `MaskedPhoneNumber` MaskedPhoneNumber — Represents a masked phone number
      - `IsEnabled` boolean — Defines if the feature is enabled
      - `PhoneNumber` string — Defines the phone number to call
      - `Code` string — Defines the code to enter
    - `DropOffLocationId` integer, nullable — Represents table service drop off location
    - `DropOffLocation` string — Represents table service drop off location
    - `AcceptedFor` string, date-time, nullable — Time store has accepted the order for
    - `InFraudZone` boolean — Was order made within a fraud zone
    - `UnusualHighValueOrder` boolean — Is order of unusually high value
    - `RejectedByUserId` integer, nullable — Id of user who rejected order, if available
    - `ChannelOrderId` string — ChannelOrderId from external channel
    - `ChannelOrderDisplayId` string — ChannelOrderDisplayId from external channel
    - `Channel` Channel — Channel.
      - `ChannelId` integer — Channel Id
      - `TranslationKey` string — Channel TranslationKey
      - `Source` 'Internal' | 'External' — Channel Source
      - `LogoUri` string — Channel Logo URl
      - `Available` boolean — Channel is Available or not
      - `MaintainedExternally` boolean — Channel is Maintained Externally or not
    - `OrderDropOffLocation` OrderDropOffLocation — OrderDropOffLocation.
      - `OrderId` integer — OrderId.
      - `LocationName` string — LocationName.
      - `LocationAreaName` string — LocationAreaName.
      - `LocationId` integer — LocationId.
      - `LocationAreaId` integer — LocationAreaId.
      - `ExternalLocationId` string — ExternalLocationId.
    - `FulfillmentStatus` OrderFulfillmentStatusBase — Fulfillment Status Information
      - `StatusId` string — Fulfillment Status Id
      - `StatusName` string — Fulfillment Status Name
      - `Icon` string — Status Icon
    - `OrderBatchInfo` OrderBatchSummary — Order batch info
      - `Id` integer — Order batch id
      - `DisplayCode` string — Order batch 6-sign human readable code
      - `CreateTime` string, date-time — Batch creation date and time
      - `IsPublished` boolean — If the batch is already published
    - `TaxItems` TaxItem[] — A collection of tax items on the order.
      - `Name` string — The name of the tax item.
      - `Rate` number, double — The tax rate applied to the item.
      - `Amount` number, double — The amount of tax applied to the item.
    - `CreatedCampaignVoucherId` integer, nullable — The id of the campaign voucher that was created from this order
    - `OrderId` integer — Order identifier
    - `LocalOrderId` string — Local order Id. This is used for displaying a "shorter" order ID for customers (eg. Kiosk orders)
    - `DeliveryType` 'Delivery' | 'Pickup' — Delivery type
    - `PickupLocationType` 'TakeOut' | 'TableService' | 'DineIn' — Pickup location type
    - `TableServiceCatagory` 'Generic' | 'Villa' | 'House' | 'Room' | 'Area' | 'Table' | 'ParkingBay' | 'Gate' | 'DriveThrough' | 'Team', nullable — Pickup location type
    - `TipAmount` number, double — Tip amount
    - `DeliveryAmount` number, double — Delivery amount
    - `OrderItemsAmount` number, double — Ordered items amount
    - `ServiceChargeAmount` number, double — Service Charge Amount
    - `ServiceChargePercentage` number, double — Service Charge Percentage
    - `Amount` number, double — This is the sum of the OrderItemsAmount, DeliveryAmount, TipAmount and Voucher.Amount (which is usually negative) and OnlineOrderingFee for cash orders. It does not include the OnlineOrderingFee in the case of card orders as this fee is charged by Flipdish directly to the customer.
    - `ProcessingFee` number, double — 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.
    - `PaymentAccountType` 'Card' | 'Cash' | 'Ideal' | 'Bancontact' | 'Giropay' | 'Eps' | 'Emv' | 'PayPal' | 'PayGreen' | 'GoogleWalletToken' — Payment account type
    - `PaymentAccountDescription` string — Payment account description (like Visa ****2371 or Apple Pay. or Cash)
    - `OrderState` 'Created' | 'PlacedCanBeCancelled' | 'ReadyToProcess' | 'AcceptedByRestaurant' | 'Dispatched' | 'Delivered' | 'Cancelled' | 'ManualReview' | 'RejectedByStore' | 'RejectedByFlipdish' | 'RejectedAutomatically' | 'RejectedAfterBeingAccepted' | 'AcceptedAndRefunded' | 'PendingPayment' — Order state
    - `IsPreOrder` boolean — Is pre-order
    - `PlacedTime` string, date-time — Order placed time
    - `RequestedForTime` string, date-time — Order requested for
    - `ChefNote` string — Chef note
    - `AppType` 'Unknown' | 'Ios' | 'Android' | 'Web' | 'Kiosk' | 'Pos' | 'TelephoneCall' | 'Sms' | 'PwaAndroid' | 'PwaIos' | 'Google' — Used app type
    - `UserRating` integer, nullable — User rating
    - `PaymentStatus` 'Paid' | 'Unpaid' | 'Refunded' | 'PartiallyRefunded' | 'Disputed' — Status of the payment
    - `RejectionReason` 'TooBusy' | 'FoodUnavailable' | 'UnableToDeliver' | 'UnknownAddress' | 'UnknownReason' | 'TooSoon' | 'TimeUnavailable' | 'DontDeliverToArea' | 'StoreUncontactable', nullable — Rejection reason. Can have value if the order is rejected.
    - `RefundedAmount` number, double, nullable — Amount refunded to customer.
    - `DeliveryTrackingStatus` 'Unassigned' | 'Unaccepted' | 'Accepted' | 'Carrying' | 'OnTheWay' | 'ArrivedAtLocation' | 'Delivered' | 'CannotDeliver', nullable — Delivery tracking status
    - `DriverId` integer, nullable — Assigned driver identifier
    - `TotalTax` number, double — Total tax applied to order
    - `OrderTrackingCode` string — Unique, 6 character long alpha numeric code for tracking.
    - `DeliveryFeeAreaId` integer, nullable — Delivery area identifier
    - `ReceiptCode` string — Code used to view the order's receipt
    - `TotalDepositReturnFeeAmount` number, double — This contains the total deposit return fee amount for the order.

## Other responses

- `400` — BadRequest
- `401` — Authentication has been denied for this request.
- `403` — Successful authentication, but authorization has been denied for this request.

---

[API](https://skmtc.net/flipdish/apis/flipdish-open-api-v1-0.md) · [All operations](https://skmtc.net/flipdish/apis/flipdish-open-api-v1-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/flipdish/flipdish-open-api-v1-0/versions/a72c0465da74/schema)