Skip to main content

List Sales Rep Performance

GET 
/api/reporting/sales-rep-commissions/performance

One row per sales rep, paginated.

Required scope: reports:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Every rep matching the filters is returned, including those with no qualifying orders in the period — they come back with zero orders, sales and commission, which is a meaningful reading of the report rather than an omission. average_order_value is zero for those reps rather than undefined.

Sorting is applied across the whole result set, not just the returned page, so sorting by commission_earned descending gives the highest earners overall.

How commission is earned is an account-level setting:

  • Sale basis — commission is earned when the order is placed, and the period is measured on the order date.
  • Fulfillment basis — commission is earned when the order ships, and the period is measured on the fulfillment date. Fully and over-fulfilled orders count in full. Partially fulfilled orders are only included if the account enables them, and then contribute only the value of the units that actually shipped.

Cancelled orders are excluded unless the account opts to include them, and an account may further restrict the report to a list of qualifying order statuses.

Sales figures are the product subtotal of each order's warehoused lines, converted to your account currency at the rate stored on the order. Commission is that value multiplied by the rep's commission rate.

Dates are interpreted in your account's timezone.

Authentication: Requires Bearer token. Scope: reports (read/write).

Request​

Responses​

OK

Response Headers
    Content-Type