---
title: "Get Orders"
method: GET
path: "/orders"
tags: ["Orders API"]
---

# Get Orders

`GET /orders`

The endpoint retrieves a list of orders based on the provided query parameters. The request includes a limit, offset, and clientId to filter the results. Additionally, the request payload includes a start date, end date, listing IDs, and channel to further refine the search.

### Response
The response for this request is a JSON object with the following structure:

```json
{
  "status": boolean,
  "statusCode": integer,
  "message": string,
  "result": {
    "total": integer,
    "orders": [
      {
        "orderId": string,
        "ListingId": string,
        "CustomerId": string,
        "channel": string,
        "customerIsPass": integer,
        "commisionPercentage": integer,
        "deliveryUUID": string,
        "orderUUID": string,
        "isPickupOrder": integer,
        "orderConfirmationTime": string,
        "orderAcceptedPosTime": string,
        "orderBeginTripTime": string,
        "orderCreationTime": string,
        "orderCompletionTime": string,
        "orderMerchantCommisson": integer,
        "orderRequestTime": string,
        "orderTax": integer,
        "orderTotalAfterDiscount": integer,
        "orderSubTotal": integer,
        "orderMerchantTax": integer,
        "orderFulfillmentMode": string,
        "orderMarketingFee": integer,
        "orderStatus": string,
        "orderNetPayout": integer,
        "taxPercentage": integer,
        "orderErrorCharges": integer,
        "orderErrors": string,
        "errorChargeExcludingTax": integer,
        "errorChargeTax": integer,
        "adjustmentExcludingTax": integer,
        "adjustmentTax": integer,
        "adsFee": integer,
        "alcoholFeeTax": integer,
        "alcoholFlatFee": integer,
        "offerTitle": string,
        "riderFirstName": string,
        "riderLastName": string,
        "preOrderMerchantTip": integer,
        "orderMerchantTip": integer,
        "giftCardCredit": integer,
        "loyaltyPoints": integer,
        "orderFailureReason": string,
        "orderMissingItems": string,
        "orderMerchantDelivery": string,
        "orderNetSubTotal": integer,
        "orderRefunds": integer,
        "orderStorePayment": integer,
        "orderTotalFees": integer,
        "promoSpendOnFood": integer,
        "createdAt": string,
        "updatedAt": string,
        "channelBy": string,
        "orderStatusDetails": string,
        "customerName": string,
        "customerFullName": string,
        "restaurantName": string,
        "restaurantAddress": string,
        "restaurantId": string,
        "restaurantCountryCode": string,
        "quotedDeliveryTime": string,
        "paymentMethod": string,
        "doordashDriveId": string,
        "driveDasherPreTip": integer,
        "deliveryFee": integer,
        "deliveryVariance": integer,
        "itemCount": integer,
        "bagFeeTotal": integer,
        "gst": integer,
        "gstOnAbBagFee": integer,
        "gstOnAbVariableServiceFee": integer,
        "hst": integer,
        "hstOnVariableServiceFeeTotal": integer,
        "timezone": string,
        "variableServiceFeeTotal": integer,
        "ezRewards": integer,
        "paymentTransactionFee": integer,
        "taxRemittedToState": integer,
        "otherPayments": integer,
        "preferredPartnerProgram": string
      }
    ]
  },
  "error": string
}
```

## Query parameters

- `limit` string
- `offset` string
- `clientId` string

## Headers

- `access-token` string

## Request body

- object
  - `channel` string[]
  - `endDate` string
  - `listingIds` string[]
  - `startDate` string

## Response `200`

200

- object
  - `error` unknown
  - `message` string
  - `result` object
    - `orders` object[]
      - `CustomerId` string, nullable
      - `ListingId` string
      - `adjustmentExcludingTax` unknown
      - `adjustmentTax` unknown
      - `adsFee` number, nullable
      - `alcoholFeeTax` number, nullable
      - `alcoholFlatFee` number, nullable
      - `bagFeeTotal` unknown
      - `channel` string
      - `channelBy` string
      - `commisionPercentage` number, nullable
      - `createdAt` string
      - `customerFullName` string, nullable
      - `customerIsPass` number
      - `customerName` string, nullable
      - `deliveryFee` number, nullable
      - `deliveryUUID` string
      - `deliveryVariance` number, nullable
      - `doordashDriveId` string, nullable
      - `driveDasherPreTip` number, nullable
      - `errorChargeExcludingTax` unknown
      - `errorChargeTax` unknown
      - `ezRewards` unknown
      - `giftCardCredit` number, nullable
      - `gst` unknown
      - `gstOnAbBagFee` unknown
      - `gstOnAbVariableServiceFee` unknown
      - `hst` unknown
      - `hstOnVariableServiceFeeTotal` unknown
      - `isPickupOrder` number, nullable
      - `itemCount` number, nullable
      - `loyaltyPoints` number, nullable
      - `offerTitle` unknown
      - `orderAcceptedPosTime` string, nullable
      - `orderBeginTripTime` string, nullable
      - `orderCompletionTime` string, nullable
      - `orderConfirmationTime` string, nullable
      - `orderCreationTime` string
      - `orderErrorCharges` number, nullable
      - `orderErrors` string, nullable
      - `orderFailureReason` unknown
      - `orderFulfillmentMode` string, nullable
      - `orderId` string
      - `orderMarketingFee` number, nullable
      - `orderMerchantCommisson` number
      - `orderMerchantDelivery` number, nullable
      - `orderMerchantTax` number
      - `orderMerchantTip` number
      - `orderMissingItems` string, nullable
      - `orderNetPayout` number
      - `orderNetSubTotal` number, nullable
      - `orderRefunds` number, nullable
      - `orderRequestTime` string, nullable
      - `orderStatus` string
      - `orderStatusDetails` string, nullable
      - `orderStorePayment` number, nullable
      - `orderSubTotal` number
      - `orderTax` number
      - `orderTotalAfterDiscount` number, nullable
      - `orderTotalFees` number, nullable
      - `orderUUID` string, nullable
      - `otherPayments` unknown
      - `paymentMethod` string, nullable
      - `paymentTransactionFee` unknown
      - `preOrderMerchantTip` number, nullable
      - `preferredPartnerProgram` unknown
      - `promoSpendOnFood` string, nullable
      - `quotedDeliveryTime` string, nullable
      - `restaurantAddress` string, nullable
      - `restaurantCountryCode` string, nullable
      - `restaurantId` string
      - `restaurantName` string, nullable
      - `riderFirstName` string, nullable
      - `riderLastName` unknown
      - `taxPercentage` number, nullable
      - `taxRemittedToState` unknown
      - `timezone` unknown
      - `updatedAt` string
      - `variableServiceFeeTotal` unknown
    - `total` number
  - `status` boolean
  - `statusCode` number

## Other responses

- `400` — 400

---

[API](https://skmtc.net/voosh/apis/voosh-api-documentation.md) · [All operations](https://skmtc.net/voosh/apis/voosh-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/voosh/voosh-api-documentation/revisions/d53ba6056960/schema)