Page Comparison

vcid

The ID of the voucher.

Numerical

mid

The ID of the advertiser (merchant) for which the voucher.

Numerical

statestatus

The status of the voucher.

Active, active or deleted

title

The name of the voucher.

codes

The voucher codes you have registered for this voucher.

discount_amount

The amount of the registered discount value.

Numerical

discount_amount_type

The registered discount type.

fix or percent.

date_from

The registered date from which the voucher is valid.

dd.mm.yyyy

date_to

The registered date after which the voucher is no longer valid.

dd.mm.yyyy

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

• 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=

• no (voucher can be used by all customers

• )

• or yes (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_allowallowed

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.

all , category or adspaces

adspace_

allowed_

pid

When the promotion of the voucher

is limited to one or more specific ad

spaces, the ID of the ad spaces will be listed here.

Numerical

adspace_allowed_category_id

When the promotion of the voucher is limited to one or more specific ad spaces only, you will find the IDs (PID) of these ad spaces space categories, the corresponding IDs will be listed here.

Numerical

commission_amounttype

This field defines whether the regular commission amount will be applied when a voucher is used or an alternative commission will be assigned.

• commission model (for the regular commission model)

• or commission value (for an alternative commission)

commission_type_amountoverride_value

If an alternative commission model is appliedassigned, the value of this commission will be visible herethe alternative commission model is defined in this field.

Numerical

commission_amounttype_typeoverride

If an alternative commission model is appliedassigned, the type of this commission (fixed or percentual) will be visible herethe alternative commission model is defined in this field.

fix or percent

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.

policy

If the promotion of a voucher is restricted to one or more specific ad spaces or to one or more ad space categories, this field defines what happens if excluded ad spaces promote the voucher.

• accept when unauthorized usage is allowed,

• adspace_redirect when the conversion is attributed to a different ad space, commission_value for the alternative commission

• and discard for discard.
  

unauthorized_policy_redirect_useadspace_valuepid

If you attribute a conversion to a different ad space in case of unauthorized usage, you will find unauthorized promotion of the voucher is redirected, this field will contain 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_policy_overwrite_commission_value

If unauthorized promotion of the voucher is accepted, transactions generated by excluded ad spaces or categories can be rewarded with a different commission. If so, this field will contain the value of this alternative commission.

Numerical

unauthorized_policy_overwrite_usecommission_type

If you assign an alternative commission in case of unauthorized usage, you will find the commission type (fixed or percentual) in this fieldunauthorized promotion of the voucher is accepted, transactions generated by excluded ad spaces or categories can be rewarded with a different commission. If so, this field will contain the type of this alternative commission.

fix or percent