| Table of Contents | ||
|---|---|---|
|
...
The tracking category, revenue, and commission cannot be changed on the top-level. You have to change it on basket-level.
You currently cannot provide an externally calculated fee for basket entries. However, you can influence the fee by changing calculation related fields, which will trigger recalculation.
When you want to change the status of an individual basket entry, you have to set the status on the basket-level.
For your convenience, there are some handy automated status changes implemented:
When you change the status of a conversion on the top-level, all basket elements will inherit this status change. Use this option if you want to change all basket entries to the same status.
When at least one basket entry is approved (
status = "1”), the top-level conversion status will also automatically change to approved.When all basket entries are rejected (
status = "2”), the top-level conversion status will also automatically change to rejected.
confirmed, rejected, rejected => conversion=approved → conversion=confirmed
confirmed, rejected, open => request is rejected
MATURITY Time!
Getting started
Domain
A CAD request has the following basic structure:
...
Parameter name | Explanation | Mandatory | Corresponding field in export file | Example |
|---|---|---|---|---|
tst | The UNIX timestamp of your request, will be filled out automatically. | No | n/a | 1429018671 |
trc | The tracking category of the conversion. The tracking category can be changed, please note that in this case update notification (3rd party tracking) may be affected. | Yes | conversion_product_category_label | basket |
ctg | The conversion target of the conversion. | Yes | conversion_target_label | sale |
cid | The order ID of the conversion. | Yes | conversion_id | 1234567asd |
cfs | The status of the conversion. Possible values are either: | Yes | conversion_status | cnf |
cfd | The time and date on which the conversion was validated. Please note that the format from the export file (yyyy-mm-dd hh:mm:ss) must be URL encoded. | No | 2015-04-14 15:37:51 | 2015-04-14%2015%3A37%3A51 |
ovn | The new order value of the conversion. Please use this parameter only when you want to adjust the order value. | No | conversion_order_value | 25.45 |
ctp | The type of commission that should be attributed to the ad space, according to the commission model applied to the transaction. Possible values are fix or percent. Please use this parameter only when you want to adjust the commission. | No | conversion_commission_type | percent |
crt | The new commission rate of the conversion. Please use this parameter only when you want to adjust the commission. | No | conversion_commission_rate | 2.5 |
unqid | A unique ID identifying the conversion, used for security purposes. | Yes | conversion_uniqid | 14e31669-6940-2204-8004-8340696916e3 |
cre | You can use this parameter to explain the reason why a conversion was canceled. | No | conversion_reason_canceled | Order%20was%20canceled. |
mkey | The magic API key identifies to identify the user processing the automated validation, making the process transparent and secure. | Yes | n/a | 0b539c09-e0de-42c6-9b9c-f4a42d92d389 |
preview_mode | Activate preview mode to process request without saving | No | n/a | 1 or true |
For more information about the magic keyAPI keys, please read this article.
For more information about the preview mode, please read this article.
Example CAD request for conversions
...
Parameter name | Description | Mandatory | Corresponding field in export file | Example |
|---|---|---|---|---|
tst | The UNIX timestamp of your request. Please note the value will be filled out automatically. | No | n/a | |
trc | The tracking category of the transaction to which the basket position belongs. Please note the tracking category must always be basket. | Yes | conversion_product_category_label | basket |
ctg | The conversion target of the transaction to which the basket position belongs. | Yes | conversion_target_label | newSale |
cid | The order ID of the transaction to which the basket position belongs. | Yes | conversion_id | 1234567asd |
unqid | A unique ID identifying the transaction, used for security purposes. | Yes | conversion_uniqid | 14e31669-6940-2204-8004-8340696916e3 |
mkey | The magic API key identifies to identify the user processing the automated validation, making the process transparent and secure. | Yes | n/a | 0b539c09-e0de-42c6-9b9c-f4a42d92d389 |
bsknew | This parameter contains all details of the basket position in JSON format (URL encoded), including the basket status that needs to be adjusted for the validation process. | Yes | n/a |
|
For more details on the basket parameter, please read this article. A comprehensive documentation on the magic key can be found here.
Possible actions for basket positions
...
For more details on the basket parameter and how to work with it, please read this article.
Example CAD request for basket positions
...
Please note this example contains one basket position only. In many cases, you will find that a conversion contains multiple basket positions, representing all the different products ordered by the customer. For further details, please read this article.