...
Name | Explanation | Possible values |
|---|---|---|
vcid | The ID of the voucher. | Numerical |
mid | The ID of the advertiser (merchant) for which the voucher. | Numerical |
state | The status of the voucher. | Active, deleted |
title | The name of the voucher. | |
codes | The voucher codes you have registered for this voucher. | |
discount | The amount of the registered discount value. | Numerical |
discount_type | The registered discount type. |
|
date_from | The registered date from which the voucher is valid. |
|
date_to | The registered date after which the voucher is no longer valid. |
|
description_partners | The description of the voucher that will be shown to your partners. | |
landingpage | The page used as landing page for campaigns associated with the voucher. Please note this field is not mandatory and can be empty. | URL |
voucher_type | The registered type of the voucher, i.e. whether the customer receives a discount, a freebie, etc. | Discount_all,discount_single,free_ship,freebie,misc |
new_cust_only | This field defines whether the voucher has been registered as aimed at new customers only. | 0 or 1. (0=voucher can be used by all customers, 1= voucher can be used by new customers only). |
min_order_value | This field defines whether a minimum order value was registered as requirement for the voucher. If there is no value in the field, there is no minimum order value required. | Numerical |
adspace_allow | This field defines the registered voucher policy: whether the voucher can be used on all ad spaces, on ad spaces that belong to a particular category or on specific ad spaces only. |
|
adspace_allow_value | If the voucher usage is limited to one or more ad space categories, you will find the IDs of these categories in this field. If the voucher usage is limited to one or more specific ad spaces only, you will find the IDs (PID) of these ad spaces here. | Numerical |
commission_amount | This field defines whether the regular commission amount will be applied when a voucher is used or an alternative commission will be assigned. |
|
commission_amount_value | If an alternative commission model is applied, the value of this commission will be visible here. | Numerical |
commission_amount_type | If an alternative commission model is applied, the type of this commission (fixed or percentual) will be visible here. |
|
unauthorized_use | In this field, you will find further information on the voucher policy, i.e. what happens with unauthorized usage of partners. Unauthorized usage can be allowed, the conversion can be attributed to a different ad space, the conversion can be rewarded with an alternative commission or the conversion can be discarded. |
|
unauthorized_use_value | If you attribute a conversion to a different ad space in case of unauthorized usage, you will find the ID of this ad space in this field. If you assign an alternative commission in case of unauthorized usage, you will find the commission amount in this field. | Numerical |
unauthorized_use_type | If you assign an alternative commission in case of unauthorized usage, you will find the commission type (fixed or percentual) in this field. |
|
Automated export
The URL required for creating the voucher data export file is build up as following:
https://export.net.[domain]/[magic_key]/adm-vouchers_[user_ID].[file_extension]?[filters]
Applying filters
For voucher data export file, following filters can be applied:
Filter description | Filter name | Compulsory | Format |
|---|---|---|---|
Allows you to limit the export to the ad media of a specific advertiser. | mid | Yes | Use the MID (merchant ID) you find overview of your advertisers. |
These filters are to be added to the URL as parameters. Use the the question mark (?) for the first parameter and the ampersand (&) for all further parameters. Add the word filter, the filter name, the equals sign (=) and the relevant values according to the format mentioned in the table.