Fetch Sales Metrics

GET {{baseUrl}}/sales/sales-metrics/public?from=<string>&to=<string>&groupByList=MERCHANT&metricsMode=BY_PROFIT&filterByMerchantId=<string>&filterByBusinessId=<string>&filterByTenantId=<string>&filterByCustomerId=<string>&filterByProductId=<string>&filterByProductPublicId=<string>&filterByPaymentMethod=PAYMENT_LINK&filterByDeliveryMode=PICK_UP&filterByDeliveryStatus=PENDING&filterByCountryCode=<string>

Description

Fetch Sales Metrics

Request

• Headers:
  • Accept: /

Response

• Status: OK (200)
• Headers:
  • Accept: /

Headers

• Accept: */*

Params

• from: <string>
• to: <string>
• groupByList: PAYMENT_METHOD, MERCHANT
• metricsMode: BY_PROFIT
• filterByMerchantId: <string>
• filterByBusinessId: <string>
• filterByTenantId: <string>
• filterByCustomerId: <string>
• filterByProductId: <string>
• filterByProductPublicId: <string>
• filterByPaymentMethod: PAYMENT_LINK
• filterByDeliveryMode: PICK_UP
• filterByDeliveryStatus: ACCEPTED, PENDING
• filterByCountryCode: <string>

Example Request

curl --location -g '{{baseUrl}}/sales/sales-metrics/public?from=%3Cstring%3E&to=%3Cstring%3E&groupByList=MERCHANT&metricsMode=BY_PROFIT&filterByMerchantId=%3Cstring%3E&filterByBusinessId=%3Cstring%3E&filterByTenantId=%3Cstring%3E&filterByCustomerId=%3Cstring%3E&filterByProductId=%3Cstring%3E&filterByProductPublicId=%3Cstring%3E&filterByPaymentMethod=PAYMENT_LINK&filterByDeliveryMode=PICK_UP&filterByDeliveryStatus=PENDING&filterByCountryCode=%3Cstring%3E' \
--header 'Accept: */*'

Example Response

{
  "message": "<string>",
  "data": [
    {
      "id": "<string>",
      "volume": "<string>",
      "totalCostPrice": "<string>",
      "totalProfit": "<string>",
      "totalSellingPrice": "<string>",
      "totalQuantitySold": "<string>",
      "totalDiscount": "<string>",
      "day": "<dateTime>"
    },
    {
      "id": "<string>",
      "volume": "<string>",
      "totalCostPrice": "<string>",
      "totalProfit": "<string>",
      "totalSellingPrice": "<string>",
      "totalQuantitySold": "<string>",
      "totalDiscount": "<string>",
      "day": "<dateTime>"
    }
  ],
  "meta": {
    "currentPage": "<long>",
    "from": "<long>",
    "to": "<long>",
    "perPage": "<long>",
    "total": "<long>",
    "lastPage": "<long>"
  }
}