Skip to main content
GET
/
v1
/
partner
/
sales
/
summary
Get sales summary
curl --request GET \
  --url http://localhost:3000/v1/partner/sales/summary
{
  "periods": [
    {
      "period": "<string>",
      "orders_count": 123,
      "total_units_sold": 123,
      "gross_sales": 123,
      "total_commission": 123,
      "net_to_partner": 123,
      "payout_status": {
        "pending": 123,
        "included": 123,
        "paid": 123
      }
    }
  ],
  "lifetime": {
    "total_orders": 123,
    "total_units_sold": 123,
    "gross_sales": 123,
    "total_commission": 123,
    "net_to_partner": 123,
    "pending_payout": 123
  }
}

Query Parameters

months
integer
default:6
Required range: 1 <= x <= 24

Response

Sales summary

periods
object[]
required
lifetime
object
required