Reporting API (2.0)

Download OpenAPI specification:Download

Affiliate reports API for:

Promotions
Orders
Commissions

AffiliateReportingV2

getPromotionsReport

Get promotions report

Authorizations:

bearerAuth

query Parameters

startDate required	string <date> Example: startDate=2022-12-31
endDate required	string <date> Example: endDate=2022-12-31

header Parameters

Authorization

string

Responses

Response samples

200
400
403
500

Content type

application/json

{"items": [{"date": "string",
"siteName": "string",
"siteCode": "string",
"frameType": "string",
"name": "string",
"subId": "string",
"clicks": 0,
"impressions": 0,
"clickThroughRate": 0,
"commission": 0,
"earningsPerClick": 0,
"earningsPerMille": 0,
"orders": 0,
"conversion": 0,
"revenueExclVat": 0,
"revenueInclVat": 0,
"averageOrderValue": 0
}
]
}

getOrdersReport

Get orders report

Authorizations:

bearerAuth

query Parameters

startDate required	string <date> Example: startDate=2022-10-10
endDate required	string <date> Example: endDate=2022-10-10

header Parameters

Authorization

string

Responses

Response samples

200
400
403
500

Content type

application/json

{"items": [{"orderDate": "string",
"orderDateTime": "string",
"orderId": "string",
"orderItemId": "string",
"productTitle": "string",
"productId": "string",
"quantity": 0,
"chunkName": "string",
"siteName": "string",
"siteCode": "string",
"frameType": "string",
"name": "string",
"subId": "string",
"priceExclVat": 0,
"priceInclVat": 0,
"commissionPercentage": 0,
"commission": 0,
"status": "string",
"statusFinal": true,
"approvedForPayment": true
}
]
}

getCommissionsReport

Get commissions report for a given affiliate

Authorizations:

bearerAuth

query Parameters

startDate required	string <date> Example: startDate=2022-10-10
endDate required	string <date> Example: endDate=2022-10-10

header Parameters

Authorization

string

Responses

Response samples

200
400
403
500

Content type

application/json

{"items": [{"orderDate": "string",
"siteName": "string",
"siteCode": "string",
"frameType": "string",
"name": "string",
"subId": "string",
"commissionPercentage": 0,
"commissionOriginal": 0,
"commissionApproved": 0,
"commissionOpen": 0,
"revenueOriginalExclVat": 0,
"revenueOriginalInclVat": 0,
"revenueApprovedExclVat": 0,
"revenueApprovedInclVat": 0,
"revenueOpenExclVat": 0,
"revenueOpenInclVat": 0,
"quantityPayable": 0
}
]
}