Skip to content

Payout Report

Per-store payout view with GMV, commission, tax, and platform margins for a date range.

Endpoint

GET /v1/products/audit/payout-report/

Authentication

Required (Admin role).

Query Parameters

Parameter Type Required Description
start_date string No Inclusive start date YYYY-MM-DD (default: 2000-01-01)
end_date string No Inclusive end date YYYY-MM-DD (default: today)
store_id int No Filter by store

Response (200)

{
  "period": {
    "start_date": "2025-12-01",
    "end_date": "2025-12-20"
  },
  "data": [
    {
      "store_id": 12,
      "store_name": "Electro World",
      "gmv": 7500.50,
      "platform_profit": 1125.08,
      "tax": 202.51,
      "platform_margin_net": 922.57,
      "platform_margin_correct": 876.44,
      "store_payout": 6375.42,
      "paid_to_store": 0,
      "not_yet_paid": 6375.42,
      "store_remaining": 6375.42,
      "order_count": 42
    }
  ]
}

Notes: - platform_profit = GMV × store percent. - tax uses the global tax percent on platform profit. - platform_margin_correct applies the global expenses% on the net margin. - Paid/unpaid store payout fields are placeholders until payout tracking is added. - Dates are inclusive; end_date is included in the results.