Skip to content
/
Get list of item promotio...

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

Create discount promotion for itemServer-sideAdmin

Request

Creates a discount promotion for an item.

Promotions provide a discount (%) on items. The discount will be applied to all prices of the specified 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
Bodyapplication/jsonrequired

Object with promotion data.

nameobjectrequired

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

Example: {"en-US":"Promotion","ru-RU":"Акция"}
name.​property name*stringadditional property
promotion_periodsArray of objects(promotion_periods)

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

discountobjectrequired
discount.​percentstringrequired

Percent discount. The price of item will be decreased using a value calculated by using this percent and then rounded to 2 decimal places.

Example: 10
itemsArray of objectsrequired
items[].​skustringrequired

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.

price_conditionsArray of objects or null(price_conditions_discount)

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 items object to null.

limitsobject(Promotions_promotion_limits)

Promotion limits.

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 POST \
  -u <username>:<password> \
  https://store.xsolla.com/api/v3/project/44056/admin/promotion/item \
  -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-16T18:16:00+05:00",
        "date_until": "2020-05-25T18:16:00+05:00"
      }
    ],
    "discount": {
      "percent": "10.00"
    },
    "items": [
      {
        "sku": "com.xsolla.elven_sword_1"
      },
      {
        "sku": "com.xsolla.elven_helmet_1"
      },
      {
        "sku": "com.xsolla.elven_armor_1"
      }
    ],
    "name": {
      "en-US": "Promotion",
      "ru-RU": "Акция"
    },
    "is_enabled": true
  }'

Responses

Promotion was successfully created.

Bodyapplication/json
promotion_idinteger

Promotion ID. Unique promotion identifier within the project.

Response
application/json
{
  "promotion_id": 2384756
}

Get list of item promotionsServer-sideAdmin

Request

Get the list of item promotions of a project.

Promotions provide a discount (%) on items. The discount will be applied to all prices of the specified items.

Security
basicAuth
Path
project_idintegerrequired

Project ID.

Default 59080
Query
limitinteger

Limit for the number of elements on the page.

offsetinteger

Number of the element from which the list is generated (the count starts from 0).

curl -i -X GET \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion/item?limit=0&offset=0'

Responses

List of item promotions was successfully received.

Bodyapplication/json
promotionsArray of objects
total_promotions_countinteger(total_promotions_count)

Total number of promotions.

active_promotions_countinteger(active_promotions_count)

Number of active promotions.

inactive_promotions_countinteger(inactive_promotions_count)

Number of deactivated promotions.

Response
application/json
{
  "promotions": [
    { … },
    { … },
    { … },
    { … }
  ],
  "total_promotions_count": 4,
  "active_promotions_count": 4,
  "inactive_promotions_count": 0
}

Update item 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.

Promotions provide a discount (%) on items. The discount will be applied to all prices of the specified 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/jsonrequired

Object with promotion data.

nameobjectrequired

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

Example: {"en-US":"Promotion","ru-RU":"Акция"}
name.​property name*stringadditional property
promotion_periodsArray of objects(promotion_periods)

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

discountobjectrequired
discount.​percentstringrequired

Percent discount. The price of item will be decreased using a value calculated by using this percent and then rounded to 2 decimal places.

Example: 10
itemsArray of objectsrequired
items[].​skustringrequired

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.

price_conditionsArray of objects or null(price_conditions_discount)

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 items object to null.

limitsobject(Promotions_promotion_limits)

Promotion limits.

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/item \
  -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-16T18:16:00+05:00",
        "date_until": "2020-05-25T18:16:00+05:00"
      }
    ],
    "discount": {
      "percent": "10.00"
    },
    "items": [
      {
        "sku": "com.xsolla.elven_sword_1"
      },
      {
        "sku": "com.xsolla.elven_helmet_1"
      },
      {
        "sku": "com.xsolla.elven_armor_1"
      }
    ],
    "name": {
      "en-US": "Promotion",
      "ru-RU": "Акция"
    },
    "is_enabled": true
  }'

Responses

Promotion was successfully updated.

Response
No content

Bonuses

This API allows to manage bonus promotions.

Operations

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