API documentation V2
The Affiliate Reporting API provides access to the affiliate reports, within a given period.
| Only request the data for the period you need and prevent unnecessarily large reports from being requested |
| Non-required fields from schema won’t be present in the response if they’re null. |
Orders
Orders consist of one or more order items. In this overview you can find detailed information on order item level.
Field descriptions
Field Name |
Description |
orderDate |
The date when the order was placed. (yyyy-MM-dd) |
orderDateTime |
The exact date and time when the order was placed. (yyyy-MM-dd HH:mm:ss) |
orderId |
The identifier of the order. |
orderItemId |
The unique identifier of the item within the order. |
productTitle |
The title of the product ordered. |
productId |
The unique identifier for the product. |
quantity |
The quantity of the product ordered. |
chunkName |
The name of the product category. |
siteName |
The name of the site where the order originated from. |
siteCode |
The unique code for the site where the order originated from. |
frameType |
The promotion type used by the affiliate link (e.g., "Tekstlink", "Productlink"). |
name |
The name given to the affiliate link. |
subId |
The identifier given to the affiliate link. |
priceExclVat |
The price of the order item including VAT (Value Added Tax). |
priceInclVat |
The price of the order item excluding VAT. |
commissionPercentage |
The commission rate as a percentage of the order item value. |
commission |
The commission earned on the order item. This does not take returns and cancellations into account. |
status |
The current status of the order item (e.g., "Open", "Geaccepteerd", "Geweigerd"). |
statusFinal |
Indicates whether the order item status is final. |
approvedForPayment |
Indicates whether the order item has been approved for payment. |
Promotion
In the promotional tool overview you can see the results of your promotional tools per day, website and it’s unique code, promotional tool, name, and subid. The results include clicks, impressions, click-through rate (CTR), commission, earnings per click (EPC), order quantity, conversion, turnover and average order value (AOV).
| Data in this dataset is grouped by: date, siteName, frameType, name, subId. |
Field descriptions
Field Name |
Description |
date |
The date when the order was placed. (yyyy-MM-dd) |
siteName |
The name of the site where the order originated from. |
siteCode |
The unique code for the site where the order originated from. |
frameType |
The promotion type used by the affiliate link (e.g., "Tekstlink", "Productlink"). |
name |
The name given to the affiliate link. |
subId |
The identifier given to the affiliate link. |
clicks |
The number of clicks recorded. |
impressions |
The number of impressions recorded. |
clickThroughRate |
The ratio of clicks to impressions. |
commission |
The total commission earned. This does not take returns and cancellations into account. |
earningsPerClick |
The amount earned per click. |
earningsPerMille |
The earnings per 1000 impressions. |
orders |
The number of orders. |
conversion |
The conversion rate. |
revenueExclVat |
The total revenue excluding VAT (Value Added Tax). |
revenueInclVat |
The total revenue including VAT. |
averageOrderValue |
The average value of each order. |
Commission
In this overview you will find your commission and turnover per day, website and it’s unique code, promotional tool, name, subid and commission percentage. In this file you will also find a breakdown of approved and outstanding turnover and commission, and the number of products purchased.
| Data in this dataset is grouped by: orderDate, siteName, frameType, name, subId and commissionPercentage. |
Field descriptions
Field Name |
Description |
orderDate |
The date when the order was placed. (yyyy-MM-dd) |
siteName |
The name of the site where the order originated from. |
siteCode |
The unique code for the site where the order originated from. |
frameType |
The promotion type used by the affiliate link (e.g., "Tekstlink", "Productlink"). |
name |
The name given to the affiliate link. |
subId |
The identifier given to the affiliate link. |
commissionPercentage |
The commission percentage of the order item. |
commissionOriginal |
The original commission amount calculated for the orders. |
commissionApproved |
The approved commission amount. |
commissionOpen |
The open commission amount. |
revenueOriginalExclVat |
The original revenue excluding VAT (Value Added Tax). |
revenueOriginalInclVat |
The original revenue including VAT. |
revenueApprovedExclVat |
The approved revenue excluding VAT. |
revenueApprovedInclVat |
The approved revenue including VAT. |
revenueOpenExclVat |
The open revenue excluding VAT. |
revenueOpenInclVat |
The open revenue including VAT. |
quantityPayable |
The quantity of items that are eligible for payment. |