Release Notes bol Affiliate Reporting API Version 2

Version 2.0

Version Release Date Release Type

2.0

11-11-2024

Major

Version 2 of the Affiliate Reporting API contains new features based on feedback provided during the Beta (version 1) and changes in field names to improve consistency.

For a full overview of the available reports please check the OpenAPI V2 specification.

BREAKING CHANGES

Naming consistency

  • The Orders report orderNumber field has been renamed to orderId

  • The Orders report priceIncludingVat field has been renamed to priceInclVat to be consistent with the Commissions- and Promotions Report

  • The Orders report priceExcludingVat field has been renamed to priceExclVat to be consistent with the Commissions- and Promotions Report

New fields introduced

New features

  • The Orders report has a new field, orderDateTime to allow for more precise filtering based on time.

  • The Orders report has a new field, orderItemId an id which can uniquely identify each bought product within an order

  • The Orders report has a new field, approvedForPayment this field indicates whether a record is approved for payment .[1]

  • The Orders report has a new field, statusFinal this field indicates whether the order item status is final.

  • The Orders report has a new field, siteCode which contains the unique code of a website.

  • The Promotions report has a new field, siteCode which contains the unique code of a website.

  • The Commissions report has a new field, siteCode which contains the unique code of a website.

1. Approved for Payment indicates whether bol has initiated the payment process for this record. It can take up to several days before the actual bank transaction is completed.