Get Order Financials

This endpoint retrieves orders with financial details

Request

• Method: GET

• URL: {{base-url}}/orders/financial

• Query Parameters:

  • limit (integer, optional): The maximum number of financial orders to retrieve.

  • offset (integer, optional): The offset for pagination.

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

• { "startDate": "YYYY-MM-DD", "endDate": "YYYY-MM-DD", "listingIds": ["string"], "channel": ["string"] }

  • startDate (string): The start date for filtering financial orders.

  • endDate (string): The end date for filtering financial orders.

  • listingIds (array of strings): The listing IDs to filter financial orders by.

  • channel (array of strings): The channels to filter financial orders by.

Response

The response is a JSON object with the following schema:

{
  "status": boolean,
  "statusCode": integer,
  "message": string,
  "result": {
    "showDummyData": boolean,
    "ordersData": [
      {
        "listingId": string,
        "deliveryUUID": string,
        "orderId": string,
        "storeId": string,
        "orderDate": string,
        "channel": string,
        "orderStatus": {
          "value": string,
          "isPositive": boolean
        },
        "subTotal": {
          "offPremise": integer
        },
        "deductions": {
          "total": integer,
          "commission": integer,
          "promoValue": integer,
          "deliveryFee": integer,
          "tips": integer,
          "marketingFees": integer,
          "paymentTransactionFee": integer,
          "ezReward": integer,
          "preferredPartnerProgram": integer,
          "deliveryCommission": integer,
          "otherPayments": integer,
          "marketingAdjustments": integer,
          "commissionTax": integer,
          "taxWithHeld": integer,
          "merchantFee": integer
        },
        "tax": integer,
        "difference": {
          "errorCharges": {
            "total": integer,
            "itemValue": integer,
            "itemTax": integer
          },
          "adjustments": {
            "total": integer,
            "itemValue": integer,
            "itemTax": integer
          },
          "refundByVoosh": {
            "total": integer,
            "itemValue": integer,
            "itemTax": integer
          },
          "total": {
            "total": integer,
            "itemValue": integer,
            "itemTax": integer
          }
        },
        "netPayout": {
          "total": integer
        },
        "estimatedPayout": integer,
        "transactions": [
          {
            "transactionId": string,
            "transactionDate": string,
            "payoutId": string,
            "transactionType": string,
            "description": string,
            "netPayout": integer
          }
        ],
        "payoutDiff": string
      }
    ]
  },
  "error": string
}