Unique catalog offer

How it works

Unique catalog offer allows you to display hidden items in the catalog for users who have entered a unique offer code. If the code is not entered, the items are not displayed.

Main features:

• setting up the list of items that are displayed after entering the code
• setting up promotions for the items that are displayed after entering the code
• configuring the total number of code redemptions within the campaign
• configuring the number of code redemptions per user within the campaign
• setting regional restrictions upon request

• generating multiple codes

• The user must be authorized to use the code.
• If the code is associated with an item that has regional restrictions, users from regions where the item is unavailable cannot see the unique offers associated with that code.
  Example: After entering the code, the Legendary Starter Pack should be displayed. The Legendary Starter Pack has a regional restriction — it is available only in the USA. If a user outside the USA enters the code, an error is returned in the response to the Verify promotion code API call, and the user cannot see or purchase the Legendary Starter Pack.

User flow

1. The authorized user opens the item catalog and sees all items except unique offers.
2. The user enters the code into a special field in the catalog and activates it.
3. The user sees unique items that are available for purchase.
4. The user purchases a unique item, after which the code is considered redeemed.

Integration flow

1. Set up a promotion with unique catalog offers.
2. Implement the display of the catalog to the user. To do this, use the API call from the Catalog subsection in the Virtual Items & Currency API call group to build the catalog.
3. Implement the display of a field in the catalog where the user enters a code.
4. Use the Verify promotion code API call to validate the code.
5. Implement the display of the item catalog, taking into account the code. To do this, pass the code value in the promo_code parameter when calling the API calls to build the catalog from the Catalog subsection in the Virtual Items & Currency API call group.
6. To create an order with a unique item, use the Create order with specified item API call. Pass the code value in the promo_code parameter in the request body. If you want to use a cart, pass the code value in the promo_code parameter in the request body when creating cart and creating order.

How to get it

Prerequisites

1. Register in Publisher Account.
2. Open your project in Publisher Account and go to the Items catalog > All items section.
3. Create items:
   • virtual currency
   • virtual currency packages
   • bundles
   • virtual items

Setting up a promotion with unique catalog offers

Use API calls to set up a unique catalog offer promotion.

1. Create a promotion with a unique catalog offer using the Create unique catalog offer promotion API call. In the items array, pass the SKUs of the items that are displayed after the code is activated. You can also specify:
   • The period of promotion by passing:
     • the start date in the date_start parameter.
     • the end date in the date_end parameter. If the end date is not specified, the promotion is indefinite.
   • Limits:
     • the number of times the promotion can be used by a specific user in the redeem_user_limit parameter
     • the number of times the code can be redeemed in the redeem_code_limit parameter
     • the total number of times the promotion can be used in the redeem_total_limit parameter
2. Generate codes for the created promotion using the Generate unique catalog offer codes API call or create a code using the Create unique catalog offer code API call. You can generate additional codes if needed. To get generated codes, use the Get unique catalog offer codes API call.
3. Activate the promotion using the Activate unique catalog offer promotion API call.

To manage the promotion, use the following API calls:

• Update unique catalog offer promotion
• Deactivate unique catalog offer promotion
• Delete unique catalog offer promotion

• Get list of unique catalog offer promotions
• Get unique catalog offer promotion