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:

{
  "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
}