Get Order Details

This endpoint retrieves the details of a specific order based on the provided query parameters.

Request

• Method: GET

• URL: {{base-url}}/orders/order-details

• Query Parameters:

  • clientId (string, required): The unique identifier of the client.

  • deliveryUUID (string, required): The unique identifier of the delivery.

  • channel (string, required): The channel through which the order was placed.

Response

The response is a JSON object with the following schema:

{
  "status": boolean,
  "statusCode": integer,
  "message": string,
  "result": {
    "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": string,
    "deliveryFee": string,
    "deliveryVariance": string,
    "itemCount": string,
    "bagFeeTotal": string,
    "gst": string,
    "gstOnAbBagFee": string,
    "gstOnAbVariableServiceFee": string,
    "hst": string,
    "hstOnVariableServiceFeeTotal": string,
    "timezone": string,
    "variableServiceFeeTotal": string,
    "paymentTransactionFee": string,
    "taxRemittedToState": string,
    "otherPayments": string,
    "preferredPartnerProgram": string
  },
  "error": string
}