Skip to content
/
Get coupon codes

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

Create coupon codeServer-sideAdmin

Request

Creates coupon code.

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
coupon_codestring(Promotions_coupon_code)[ 1 .. 128 ] characters^[a-zA-Z0-9]+$

Unique case sensitive code. Contains letters and numbers.

Default "WINTER2021"
Example: "WINTER2021"
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/api/liveops/v2/project/44056/admin/coupon/coupon_44056_1/code \
  -H 'Content-Type: application/json' \
  -d '{
    "coupon_code": "WINTER2021"
  }'

Responses

Code was successfully created.

Bodyapplication/json
codestring(Promotions_coupon_code)[ 1 .. 128 ] characters^[a-zA-Z0-9]+$

Unique case sensitive code. Contains letters and numbers.

Default "WINTER2021"
Example: "WINTER2021"
Response
application/json
{
  "code": "WINTER2021"
}

Get coupon codesServer-sideAdmin

Request

Gets coupon codes.

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
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/v2/project/44056/admin/coupon/coupon_44056_1/code?limit=50&offset=0'

Responses

List of codes for a coupon was successfully received.

Bodyapplication/json
codesArray of objects
total_countnumber

Total count of coupon codes.

Response
application/json
{
  "codes": [
    { … },
    { … },
    { … },
    { … },
    { … }
  ],
  "total_count": 5
}

Generate coupon codesServer-sideAdmin

Request

Generates coupon codes.

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
countinteger(Promotions_coupon-generate-count)[ 1 .. 100000 ]required
Example: 10
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/api/liveops/v2/project/44056/admin/coupon/coupon_44056_1/code/generate \
  -H 'Content-Type: application/json' \
  -d '{
    "count": 10
  }'

Responses

Codes were successfully generated.

Bodyapplication/json
countinteger(Promotions_coupon-generate-count)[ 1 .. 100000 ]
Example: 10
Response
application/json
{
  "count": 10
}

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

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