Skip to content
/
Set value points for item...

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

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

Get list of items with value pointsServer-sideAdmin

Request

Gets list of all items with value points within a project for administration.

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
value_point_skustringrequired

Value Point SKU.

Example: value_point_3
curl -i -X GET \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/items/value_point_3/value_points/rewards

Responses

The list of items with the value point reward was successfully received.

Bodyapplication/json
itemsArray of objects(admin-item-value-point-reward)
Response
application/json
{
  "items": [
    { … },
    { … }
  ]
}

Set value points for itemsServer-sideAdmin

Request

Assigns value points to one or several items by an SKU. Users receive value points after they purchase these items.

Note that this PUT request overwrites all previously set value points for items in the project.

To avoid unintentional deletion of value points, include all items and their respective value points in each PUT request.

If you only want to update the value points for a specific item while preserving the value points of other items, you should retrieve the current set of value points using a GET request, modify the desired item's value points, and then send the modified set of value points back with the updated value points for the specific item.

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
value_point_skustringrequired

Value Point SKU.

Example: value_point_3
Bodyapplication/jsonArray [
skustring(sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$required

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

Example: "booster_mega_1"
amountintegerrequired

Amount of value points.

]
curl -i -X PUT \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/items/value_point_3/value_points/rewards \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "sku": "com.xsolla.booster_1",
      "amount": 100
    },
    {
      "sku": "com.xsolla.booster_mega",
      "amount": 200
    }
  ]'

Responses

Value point rewards for items were successfully updated.

Body
Response
No content

Partially update value points for itemsServer-sideAdmin

Request

Partially updates the number of value points for one or more items by the item’s SKU. Users receive these value points after purchasing the specified items.

Principles of updating value points:

  • If an item does not yet have value points, sending a non-zero value in the amount field creates them.
  • If an item already has value points, sending a non-zero value in the amount field updates them.
  • If amount is set to 0, the existing value points for that item are deleted.

Unlike the PUT method (Set value points for items), this PATCH method does not overwrite all existing value points for items in the project, it only updates the specified items.

A single request can update up to 100 items. Duplicate item SKUs cannot be included in the same request.

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
value_point_skustringrequired

Value Point SKU.

Example: value_point_3
Bodyapplication/jsonArray [
skustring(sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$required

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

Example: "booster_mega_1"
amountinteger>= 0required

Amount of value points.

]
curl -i -X PATCH \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/items/value_point_3/value_points/rewards \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "sku": "booster_1",
      "amount": 100
    },
    {
      "sku": "booster_mega",
      "amount": 0
    }
  ]'

Responses

Value point rewards for items were successfully updated.

Body
Response
No content

Client

Operations

Clans client

Operations

Admin

Operations

Client

Operations

Admin

Operations

Client

Operations

Admin

Operations

Client

Operations