Skip to main content

Get Commissions by Group

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

Total orders, sales and commission for the period, grouped by sales rep group.

Required scope: reports:read

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

Reps who belong to no group are returned as a single row with a null group_id and the name Unassigned. rep_count is the number of distinct reps in that group who had at least one qualifying order, so a group whose reps were all idle does not appear.

The summary object totals every returned row and echoes back the requested period.

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