Skip to content

Audit Overview

Get global audit metrics (GMV, commission, margin) for a date range.

Endpoint

GET /v1/products/audit/overview/

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"
  },
  "settings": {
    "tax_percent": 18,
    "expenses_percent": 5
  },
  "totals": {
    "gmv": 12500.75,
    "platform_profit": 1875.11,
    "platform_margin_net": 1537.59,
    "platform_correct_margin": 1460.71,
    "tax_total": 337.52,
    "expenses_total": 76.88,
    "paid_to_stores": 0,
    "not_yet_paid_to_stores": 10625.64,
    "tax_paid": 0,
    "tax_unpaid": 337.52
  }
}

Notes: - platform_profit is the sum of store commissions (order price × store percent). - platform_margin_net = platform_profit − tax (tax percent on platform_profit). - platform_correct_margin = platform_margin_net − expenses% of margin. - paid_to_stores/not_yet_paid_to_stores and tax_paid/tax_unpaid are placeholders until payout/tax settlement tracking is added. - Dates are inclusive; end_date includes the entire specified day.