Salesforce

Publisher API: GET commissiongroups

« Go Back
Information
Publisher API: GET commissiongroups
All information about GET commissiongroups API call
Publisher-API-GET-commissiongroups
Details
Do you offer an API call to get information about joined programmes' commission groups?

GET commissiongroups

Publishers can request all commission groups of a programme, together with the commission values they get. Furthermore it is possible to just pull the commission value for a single commission group.
 

Who can use it

Publishers that have an active relationship with at least one programme.
 

How to call it

https://api.awin.com/publishers/45628/commissiongroups?advertiserId=1001 (for all commission groups of a certain advertiser)
Add the parameter 'accessToken' to provide your access key as described in How do I generate my Publisher API access token?
 

How the response looks

For all commission groups of an advertiser:

{
  "advertiser": 1001,
  "publisher": 45628,
  "commissionGroups": [
    {
      "groupId": 147,
      "groupCode": "GP1",
      "groupName": "group 1",
      "type": "percentage",
      "percentage": 2
    },
 
    {
      "groupId": 19474,
      "groupCode": "JS",
      "groupName": "Julius's's",
      "type": "fix",
      "amount": 100,
      "currency": "GBP"
    },
 
(…)

 

Which datafields do we provide

Field nameDescription
groupIdthe ID of the commission groups, it is unique even across advertisers
groupCodecode of the commission group, not necessarily unique across advertisers
groupNamename of the commission group, can provide additional information to the groupCode
typecan be either "fix" or "percentage"
amountonly available for type "fix"
currencyonly available for type "fix"
percentageonly available for type "percentage"
Version Info
 
Needs Review
Published
Checked
English
Main Article Info
23/02/2022, 08:58
15/12/2022, 10:49
13,920
21/02/2022, 14:43
Translation Info
System info
Valentina Porro
Jesús Iglesias Berenguer

Powered by