Skip to content

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 API provides endpoints to drive ongoing player engagement with dynamic promotions and personalized experiences. Use the endpoints to manage coupons, promo codes, discounts, bonuses, unique catalog offers, reward chains, daily chains, offer chains, and upsell.

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Mock server
https://xsolla.redocly.app/_mock/api/liveops/
https://store.xsolla.com/api/

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

Create unique catalog offer promotionServer-sideAdmin

Request

Creates a unique catalog offer promotion.

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/json
external_idstring(Promotions_coupon-external_id)required

Unique promotion ID. The external_id may contain only lowercase and uppercase Latin alphanumeric characters, periods, dashes, and underscores.

Default "coupon_external_id"
Example: "coupon_external_id"
date_startstring or null(date-time)(Promotions_coupon_date_start)

Date when your promotion will be started.

Default "2020-04-15T18:16:00+05:00"
date_endstring or null(date-time)(Promotions_coupon_date_end)

Date when your promotion will be finished. Can be null. If date_end is null, promotion will be unlimited by time.

Default "2020-04-15T18:16:00+05:00"
nameobject(Promotions_coupon_name)required

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

Default {"en-US":"Coupon title","de-DE":"Gutscheintitel"}
Example: {"en-US":"Coupon title","de-DE":"Gutscheintitel"}
name.​property name*stringadditional property
itemsArray of strings(Promotions_unique_catalog_offer_items)

A list of items SKU that are available after using the unique catalog offer.

Example: ["booster_mega_1"]
redeem_user_limitinteger or null(Promotions_coupon-redeem_user_limit)

Limits total numbers of coupons redeemed by single user.

Default 10
Example: 10
redeem_code_limitinteger or null(Promotions_redeem_code_limit)

Number of redemptions per code.

Default 10
Example: 10
redeem_total_limitinteger or null(Promotions_coupon-redeem_total_limit)

Limits total numbers of coupons.

Default 10
Example: 10
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/api/liveops/v3/project/44056/admin/unique_catalog_offer \
  -H 'Content-Type: application/json' \
  -d '{
    "external_id": "offer_external_id",
    "date_start": "2020-04-15T18:16:00+05:00",
    "date_end": "2020-04-25T18:16:00+05:00",
    "name": {
      "en-US": "New Year Offer",
      "de-DE": "Neujahrsangebot"
    },
    "items": [
      "elven_sword",
      "elven_boots"
    ]
  }'

Responses

Unique catalog offer was successfully created.

Bodyapplication/json
external_idstring(Promotions_coupon-external_id)

Unique promotion ID. The external_id may contain only lowercase and uppercase Latin alphanumeric characters, periods, dashes, and underscores.

Default "coupon_external_id"
Example: "coupon_external_id"
Response
application/json
{
  "external_id": "coupon_external_id"
}

Get list of unique catalog offer promotionsServer-sideAdmin

Request

Gets the list of unique catalog offer promotions of a project.

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
Query
limitinteger>= 1

Limit for the number of elements on the page.

Example: limit=50
offsetinteger>= 0

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

Example: offset=0
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/api/liveops/v3/project/44056/admin/unique_catalog_offer?limit=50&offset=0'

Responses

The list of coupons was successfully received.

Bodyapplication/json
itemsArray of objects(Promotions_200-get-unique-catalog-offer-promotion-model)
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
{
  "items": [
    { … },
    { … }
  ],
  "total_promotions_count": 2,
  "active_promotions_count": 2,
  "inactive_promotions_count": 0
}

Update unique catalog offer promotionServer-sideAdmin

Request

Updates the unique catalog offer promotion.

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
external_idintegerrequired

Promotion external ID. Unique promotion identifier within the project.

Example: coupon_44056_1
Bodyapplication/json
promotion_periodsArray of objects(promotion_periods)

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

nameobject(Promotions_coupon_name)required

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

Default {"en-US":"Coupon title","de-DE":"Gutscheintitel"}
Example: {"en-US":"Coupon title","de-DE":"Gutscheintitel"}
name.​property name*stringadditional property
itemsArray of strings(Promotions_unique_catalog_offer_items)

A list of items SKU that are available after using the unique catalog offer.

Example: ["booster_mega_1"]
redeem_total_limitinteger or null(Promotions_coupon-redeem_total_limit)

Limits total numbers of coupons.

Default 10
Example: 10
redeem_user_limitinteger or null(Promotions_coupon-redeem_user_limit)

Limits total numbers of coupons redeemed by single user.

Default 10
Example: 10
redeem_code_limitinteger or null(Promotions_redeem_code_limit)

Number of redemptions per code.

Default 10
Example: 10
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/api/liveops/v3/project/44056/admin/unique_catalog_offer/coupon_44056_1 \
  -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 Offer",
      "de-DE": "Neujahrsangebot"
    },
    "items": [
      "elven_sword",
      "elven_boots"
    ]
  }'

Responses

Unique catalog offer was successfully updated.

Response
No content

Discounts

This API allows to you to manage discount promotions.

Operations

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