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

# GET /api/v1.0/{appId}/orders/summaries

`GET /api/v1.0/{appId}/orders/summaries`

## Path parameters

- `appId` string, required

## Query parameters

- `searchQuery` string
- `physicalRestaurantId` integer[]
- `state` string[]
- `page` integer
- `limit` integer
- `orderByRequestedForTime` boolean
- `channels` string[]
- `orderIds` integer[]
- `from` string, date-time
- `to` string, date-time
- `logSql` boolean

## Response `200`

OK

- RestApiPaginationResultOrderSummary — Rest api pagination result
  - `Page` integer, required — Current page index
  - `Limit` integer, required — Current page size
  - `TotalRecordCount` integer, required — Total record count
  - `Data` OrderSummary[], required — Generic data object.
    - `OrderId` integer — Order identifier
    - `DeliveryType` 'Delivery' | 'Pickup' — Delivery type
    - `PickupLocationType` 'TakeOut' | 'TableService' | 'DineIn' — Pickup location type
    - `TableServiceCatagory` 'Generic' | 'Villa' | 'House' | 'Room' | 'Area' | 'Table' | 'ParkingBay' | 'Gate' | 'DriveThrough' | 'Team', nullable — Table service category
    - `OrderState` 'Created' | 'PlacedCanBeCancelled' | 'ReadyToProcess' | 'AcceptedByRestaurant' | 'Dispatched' | 'Delivered' | 'Cancelled' | 'ManualReview' | 'RejectedByStore' | 'RejectedByFlipdish' | 'RejectedAutomatically' | 'RejectedAfterBeingAccepted' | 'AcceptedAndRefunded' | 'PendingPayment' — Order state
    - `RequestedForTime` string, date-time — Order requested for
    - `StoreName` string — Name of the store
    - `StoreIanaTimeZone` string — Store IANA time zone
    - `CustomerName` string — Name of the customer
    - `CustomerPhoneNumber` string — Phone number of customer
    - `Amount` number, double — This is the sum of the OrderItemsAmount, DeliveryAmount, TipAmount and Voucher.Amount (which is usually negative) and OnlineOrderingFee It does include the OnlineOrderingFee
    - `RefundedAmount` number, double — Refunded amount
    - `PaymentAccountType` 'Card' | 'Cash' | 'Ideal' | 'Bancontact' | 'Giropay' | 'Eps' | 'Emv' | 'PayPal' | 'PayGreen' | 'GoogleWalletToken' — Payment Account
    - `PaymentStatus` 'Paid' | 'Unpaid' | 'Refunded' | 'PartiallyRefunded' | 'Disputed' — Status of the payment
    - `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 of payment
    - `AppType` 'Unknown' | 'Ios' | 'Android' | 'Web' | 'Kiosk' | 'Pos' | 'TelephoneCall' | 'Sms' | 'PwaAndroid' | 'PwaIos' | 'Google' — Type of app end user is on
    - `LocalOrderId` string — Local order Id. This is used for displaying a "shorter" order ID for customers (eg. Kiosk orders)
    - `DropOffLocationId` integer, nullable — id of the collection/drop off location
    - `DropOffLocation` string — Represents table service drop off location
    - `AcceptedFor` string, date-time, nullable — Time store has accepted the order for
    - `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
    - `InFraudZone` boolean — Was order made within a fraud zone
    - `UnusualHighValueOrder` boolean — Is order of unusually high value
    - `ChannelOrderId` string — ChannelOrderId from external channel
    - `ChannelOrderDisplayId` string — ChannelOrderDisplayId from external channel
    - `OrderDropOffLocation` OrderDropOffLocation — OrderDropOffLocation.
      - `OrderId` integer — OrderId.
      - `LocationName` string — LocationName.
      - `LocationAreaName` string — LocationAreaName.
      - `LocationId` integer — LocationId.
      - `LocationAreaId` integer — LocationAreaId.
      - `ExternalLocationId` string — ExternalLocationId.
    - `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
    - `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

## 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)