Affiliate Program

Affiliate commission report (read-only).

A read-only report of the affiliate commissions this brand has recorded, over a date range of when each was earned (UTC days, inclusive). With groupBy none (the default) it returns one row per commission, paged: its id, the affiliate membership id, amount, rate applied, type, status, the payout it is in and when it was earned and became payable — never the sale or customer behind it. With groupBy affiliate, payout, status or month it returns a count and dollar total per group instead. Totals (count, amount and a per-status breakdown) are always included.

get/api/v1/affiliate-program/commission-report

Request

  • Base URL: https://api-dev.fusehealth.com
  • URL: https://api-dev.fusehealth.com/api/v1/affiliate-program/commission-report
  • Auth: API key in header x-api-key

Query parameters

fromstring date
tostring date
groupBy'none' | 'affiliate' | 'payout' | 'status' | 'month'
affiliateMembershipIdstring
status'pending' | 'included_in_payout' | 'paid' | 'refunded'
limitinteger
offsetinteger

Response

Success

successboolean
messagestring
dataunknown

Changes

No recorded changes to this operation across all 1 revision of this API.