Skip to content
/
Get bonus promotion

LiveOps API (2.0.0)

Overview

  • Version: 2.0.0
  • Servers: https://store.xsolla.com/api
  • Contact Us by Email
  • Contact URL: https://xsolla.com/
  • Required TLS version: 1.2

LiveOps is a toolkit for driving ongoing player engagement through promotions and personalized offers.

Use the API to manage the following features:

  • Promotions — create and manage coupons, promo codes, discounts, and bonus campaigns.
  • Personalization — specify the conditions for displaying the item catalog and applying promotions only for certain authorized users.
  • Promotion limits — set a limit on how many times a promotion can be used by a user and configure scheduled resets for these limits.
  • Reward chains & Value points — configure reward progressions tied to value point accumulation.
  • Daily chains — set up recurring daily rewards to motivate regular logins.
  • Offer chains — build sequential purchase offers with per-step pricing and free reward options.
  • Upsell — a sales method in which the user is offered to buy an item with additional value.

API calls

The API is divided into the following groups:

  • Admin — calls for creating, updating, activating, and deleting campaigns and chain configurations. Authenticated via basic access authentication with your merchant or project credentials.
  • Client — calls for retrieving available promotions, getting active chains, redeeming codes, and claiming rewards on behalf of authenticated end users. Authenticated via user JWT.
Download OpenAPI description
index.json
index.yaml
Languages
Servers
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/api/liveops/

Common

Operations

Coupons

This API allows to you to manage coupons.

Operations

Promo codes

This API allows to manage promo codes.

Operations

Unique catalog offers

This API allows to you to manage unique catalog offers.

Operations

Discounts

This API allows to you to manage discount promotions.

Operations

Bonuses

This API allows to manage bonus promotions.

Operations

Update bonus promotionServer-sideAdmin

Request

Updates the promotion.

Note

New data will replace old data. If you want to update only a part of a promotion, you should transfer all required data in request as well.

Promotion adds free bonus items to the purchase made by a user. The promotion can be applied to every purchase within a project or to a purchase that includes particular items.

Security
basicAuth
Path
project_idintegerrequired

Project ID. You can find this parameter in your Publisher Account next to the name of the project.

Example: 44056
promotion_idintegerrequired

Promotion ID. Unique promotion identifier within the project.

Example: 111425
Bodyapplication/json
idinteger

Promotion ID. Unique promotion identifier within the project.

promotion_periodsArray of objects(promotion_periods)

Promotion validity periods. If multiple periods are specified, both date_from and date_until are required.

nameobjectrequired

Name of promotion. Should contain key/value pairs where key is a locale with "^[a-z]{2}-[A-Z]{2}$" format, value is string.

Example: {"en-US":"Summer season bonus","de-DE":"Sommersaison Bonus"}
name.​property name*stringadditional property
conditionArray of objects or nullrequired

Set of items required to be included in the purchase for applying a promotion. If this parameters is null, a promotion will be applied to any purchases within a project.

condition[].​skustring

Item SKU.

Default "elven_sword"
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(promotion_user-attribute_conditions_model-post)[ 1 .. 100 ] items

Conditions for validating user attributes. Determine promotion availability based on whether user attributes match all specified conditions.

bonusArray of objects or nullrequired
bonus[].​skustring

Item SKU.

Default "elven_shield"
bonus[].​quantitynumber

Item quantity.

Default 1
limitsobject(Promotions_promotion_limits)

Promotion limits.

price_conditionsArray of objects or null(price_conditions_bonus)

Array of objects with conditions that set the price range for applying the promotion.
The promotion applies only to items whose price meets all the conditions in the array. If you pass this array, set the value of the condition object to null.

excluded_promotionsArray of integers(excluded_promotions)

List of promotion IDs to exclude when applying this promotion.
Example: [12, 789]

Example: [12,789]
is_enabledboolean(Promotions_is_enabled)

Whether promotion is enabled or not.

Example: true
curl -i -X PUT \
  -u <username>:<password> \
  https://store.xsolla.com/api/v3/project/44056/admin/promotion/111425/bonus \
  -H 'Content-Type: application/json' \
  -d '{
    "promotion_periods": [
      {
        "date_from": "2020-04-15T18:16:00+05:00",
        "date_until": "2020-04-25T18:16:00+05:00"
      },
      {
        "date_from": "2020-05-15T18:16:00+05:00",
        "date_until": "2020-05-25T18:16:00+05:00"
      }
    ],
    "name": {
      "en-US": "New Year Bonus",
      "de-DE": "Neujahrsbonus"
    },
    "condition": [
      {
        "sku": "com.xsolla.elven_boots_1"
      },
      {
        "sku": "com.xsolla.elven_knife_1"
      }
    ],
    "bonus": [
      {
        "sku": "com.xsolla.elven_sword_1",
        "quantity": 1
      },
      {
        "sku": "com.xsolla.elven_shield_1",
        "quantity": 2
      },
      {
        "sku": "com.xsolla.elven_gloves_1",
        "quantity": 2
      }
    ]
  }'

Responses

Promotion was successfully updated.

Response
No content

Get bonus promotionServer-sideAdmin

Request

Gets the bonus promotion.

Promotion adds free bonus items to the purchase made by a user. The promotion can be applied to every purchase within a project or to a purchase that includes particular items.

Security
basicAuth
Path
project_idintegerrequired

Project ID. You can find this parameter in your Publisher Account next to the name of the project.

Example: 44056
promotion_idintegerrequired

Promotion ID. Unique promotion identifier within the project.

Example: 111425
curl -i -X GET \
  -u <username>:<password> \
  https://store.xsolla.com/api/v3/project/44056/admin/promotion/111425/bonus

Responses

Bonus promotion was successfully received.

Bodyapplication/json
idinteger

Promotion ID. Unique promotion identifier within the project.

promotion_periodsArray of objects(promotion_periods)

Promotion validity periods. If multiple periods are specified, both date_from and date_until are required.

nameobject

Name of promotion. Should contain key/value pairs where key is a locale with "^[a-z]{2}-[A-Z]{2}$" format, value is string.

Example: {"en-US":"Summer season bonus","de-DE":"Sommersaison Bonus"}
is_enabledboolean
Default true
conditionArray of objects or null

Set of items required to be included in the purchase for applying a promotion. If this parameters is null, a promotion will be applied to any purchases within a project.

bonusArray of objects or null
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(promotion_user-attribute_conditions_model-get)[ 1 .. 100 ] items

Conditions for validating user attributes. Determine promotion availability based on whether user attributes match all specified conditions.

limitsobject(Promotions_promotion_limits_response)

Promotion limits.

excluded_promotionsArray of integers(excluded_promotions)

List of promotion IDs to exclude when applying this promotion.
Example: [12, 789]

Example: [12,789]
price_conditionsArray of objects or null(price_conditions_bonus)

Array of objects with conditions that set the price range for applying the promotion.
The promotion applies only to items whose price meets all the conditions in the array. If you pass this array, set the value of the condition object to null.

Response
application/json
{
  "id": 1,
  "promotion_periods": [
    { … }
  ],
  "name": {
    "en-US": "New Year Bonus",
    "de-DE": "Neujahrsbonus"
  },
  "is_enabled": true,
  "condition": [
    { … },
    { … }
  ],
  "bonus": [
    { … },
    { … },
    { … }
  ],
  "limits": {
    "per_user": { … },
    "per_item": null,
    "recurrent_schedule": { … }
  },
  "excluded_promotions": [
    23,
    45
  ],
  "price_conditions": [
    { … },
    { … }
  ]
}

Delete bonus promotionServer-sideAdmin

Request

Deletes bonus promotion. The deleted promotion:

  • Disappears from the list of promotions set up in your project.
  • Is no longer applied to the item catalog and the cart. User can’t get bonus items with this promotion.

After deletion, the promotion can’t be restored.

Security
basicAuth
Path
project_idintegerrequired

Project ID. You can find this parameter in your Publisher Account next to the name of the project.

Example: 44056
promotion_idintegerrequired

Promotion ID. Unique promotion identifier within the project.

Example: 111425
curl -i -X DELETE \
  -u <username>:<password> \
  https://store.xsolla.com/api/v3/project/44056/admin/promotion/111425/bonus

Responses

Promotion was successfully deleted.

Response
No content

Personalized catalog

This API allows to specify rules for user attributes. If the user meets all conditions for a concrete rule, personalized items will be shown.

For personalized promotions see Promotions section.

To pass attributes before a purchase, you can use Xsolla Login API or pass them into user.attributes property while generating token using Pay Station API.

Operations

Management

Operations

Admin

Operations

Client

Operations

Clans client

Operations

Admin

Operations

Client

Operations

Admin

Operations

Client

Operations

Admin

Operations

Client

Operations