Unique promo codes

  • Updated

Unique promo codes are promo codes assigned to specific publishers.

About unique promo codes

When using generic promo codes, actions are attributed based on the UID of a publisher that brought a user to an advertiser’s website. However, this attribution model is not convenient when you need to provide a special promo code to one or more publishers: if other publishers copy the promo code and use it with their affiliate links, all actions of users that followed these links will be assigned to them, and not to the publisher for whom the promo code was originally designed.

In the case of unique promo codes, actions are assigned based on the value of the unique promo code, which is bound to a particular publisher. The UID is ignored. Thus, it does not matter whose ad space the user came from, the action will in any case be credited to the publisher who owns the promo code.

In addition, this attribution mechanism allows publishers to use unique promo codes offline, for example, print them on flyers and distribute them at events.

How to work with unique promo codes

  1. Send your account manager a list of promo codes and publishers’ logins for whom they are designed.
  2. The account manager adds unique promo codes to the Admitad Affiliate system and passes them to the publishers.
  3. The publishers attract users with promo codes online or offline.
  4. A user enters the promo code when placing an order.
  5. The order data including the value of the promo code are sent from your side to the Admitad Affiliate side.
  6. Based on this value, the system assigns the order to the publisher to whom the promo code is bound.

You can create as many unique promo codes for one publisher, as you want. Also, there is no limit on the total number of promo codes for all publishers.

 

Transferring data on orders with unique promo codes to Admitad Affiliate

Here, you have two options:

Automatic transfer of orders with unique promo codes

Integration via TagTag

0. Read the article "Integration via tracking code".

1. Make sure there is a coupon entry field on the checkout page

2. Enter the unique promo code from the checkout page to the parameter discountCode.

Example of a code

ADMITAD.Invoice.referencesOrder = ADMITAD.Invoice.referencesOrder || [];
// adding items to the order
ADMITAD.Invoice.referencesOrder.push({
	orderNumber: "{{order number}}", // internal order ID (not more than 100 characters)
	discountCode: "{{promocode}}", // unique promo code
	orderedItem: orderedItem
});

3. Transferring the unique promo code order information always set up “adm” value to the deduplication parameter as the order belongs to Admitad.

ADMITAD.Invoice.broker = "adm"; 

4. Transferring a regular order (not one with a unique promo code), use the standard deduplication setting.

Attribution logic

    • EN_Unique-promo-codes-1.png

 

If you installed the Admitad Affiliate tracking code in Google Tag Manager, the setup process will be different. Read more about transfer of unique promo codes through tracking code in GTM here.

 

Integration via postback request

0. Read the article "Integration via postback request".

1. Make sure there is a coupon entry field on the checkout page

2. Enter the unique promo code from the checkout page to the parameter promocode.

Parameter name Description Type
promocode unique promo code string, 255 characters

Example of a postback-request
https://ad.admitad.com/r?campaign_code=your_campaign_code&postback=1&postback_key=your_postback_key
&action_code=1&uid=03b374fa9c2f34069e8df0bda61b8627&order_id=123456&tariff_code=1&currency_code=RUB
&price=50000&quantity=1&position_id=3&position_count=3&product_id=31&client_id=&payment_type=sale&promocode=admitad500

3. Make sure all unique promo code orders are transmitted to Admitad Affiliate.
The order should be transmitted to Admitad Affiliate if:

  • The order contains both admitad_uid and unique promo code;
  • The order contains only the unique promo code;
  • The order contains only the admitad_uid.

The unique promo code order information should not be transmitted to any other channel.

Integration via plugins

At the moment, unique promo codes are supported in Magento 1 and WooCommerce. The service may be added to other plugins on request.

Integration via XML

0. Read the article "Integration via XML".

1. Make sure there is a coupon entry field on the checkout page

2. Enter the unique promo code from the checkout page to the parameter promocode.

Parameter name Description Type
promocode unique promo code string, 255 characters

3. Having the unique promo code, the order should be included in the XML upload file regardless the admitad_uid.
The order should be transmitted to Admitad Affiliate if

  • The order contains both admitad_uid and unique promo code;
  • The order contains only the unique promo code;
  • The order contains only the admitad_uid.

The unique promo code order information should not be transmitted to any other channel.

Example of an XML-file for a unique promo code order

<?xml version="1.0" encoding="UTF-8"?>
<payment_list version="2">
    <payment>
        <uid>admitad_uid</uid>
        <order_id>15</order_id>
        <product_id>125</product_id>
        <tracking>Hand tools - chainsaw</tracking>
        <quantity>1</quantity>
        <currency_code>USD</currency_code>
        <price>20</price>
        <position_id>1</position_id>
        <payment_type>sale</payment_type>
        <action_code>1</action_code>
        <tariff_code>1</tariff_code>
        <position_count>1</position_count>
        <promocode>10OFF</promocode>
    </payment>
</payment_list>

 

Integration via API

Make sure unique promo code orders are in the list of orders available to Admitad Affiliate via API

The order should be transmitted to Admitad Affiliate if:

  • The order contains both admitad_uid and unique promo code
  • The order contains only the unique promo code
  • The order contains only the admitad_uid

The unique promo code order information should not be transmitted to any other channel.

Transferring order data in the .xlsx file

You can transfer data on orders with unique promo codes in a file.

1. Request the file template from your manager.

2. Fill out the file with the data on orders with unique promo codes.

Required parameters:

  • promocode — the promo code name.
  • price — the order amount.

Optional parameters:

  • datetime_action — the time the order was made in the YYYY-MM-DD HH:MM:SS format.
    If you leave this field empty, the order time will be automatically specified as the time the file was uploaded into the system.
  • order_id — the order ID.
    If you leave this field empty, the unique order_id with the "UNIQUE_PROMOCODE" tag will be generated at the upload of the file into the system.
    Example: Egc7VsFpuY-UNIQUE_PROMOCODE

3. Send the completed file to your manager. They will upload it to the system.

Was this article helpful?