Skip to content
/
Get catalog filter rule

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

Get all catalog rules for searching on client-sideServer-sideAdmin

Request

Gets a list of all catalog rules for searching on the client-side.

Attention

Returns only rule id, name and is_enabled
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
curl -i -X GET \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/user/attribute/rule/all

Responses

Rules were successfully received.

Bodyapplication/json
itemsArray of objects(user-attribute_personalized-catalog_all)
Response
application/json
{
  "items": [
    { … },
    { … }
  ]
}

Get catalog filter ruleServer-sideAdmin

Request

Get specific rule applying to user attributes.

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
rule_idnumberrequired

Rule ID.

Example: 1
curl -i -X GET \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/user/attribute/rule/1

Responses

Rule was successfuly recieved.

Bodyapplication/json
rule_idnumberrequired

Rule ID.

namestringrequired

Readable name of a rule. Used to display a rule in Publisher Account.

is_enabledbooleanrequired

If rule is enabled.

is_satisfied_for_unauthboolean

Whether the item is displayed to unauthorized users. If true, the item is displayed to the unauthorized user regardless of catalog display rules. false by default.

attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(personalized-catalog_user-attribute_conditions_model-get)[ 1 .. 100 ] itemsrequired

Conditions for validating user attributes. Determine item availability in the catalog based on whether user attributes match all specified conditions.

One of:
attribute_conditions[].​attributestring(user-attribute_conditions_properties_attribute)[ 1 .. 255 ] characters^[-_.\d\w]+$

User attribute code.

attribute_conditions[].​typestring(user-attribute_conditions_properties_type-string)

User attribute type.

Value"string"
attribute_conditions[].​operatorstring(user-attribute_conditions_properties_operator_string)

Type of operation performed by condition. For string attribute type.

Enum ValueDescription
eq

Equals

ne

Not equals

attribute_conditions[].​valuestring(user-attribute_conditions_properties_value)<= 255 characters

Condition value which user attribute value will be compared to. Type depends on attribute type.

attribute_conditions[].​can_be_missingboolean(user-attribute_conditions_properties_can_be_missing)

Indicates that the condition is met even if attribute is missing from user attributes. Pass true to show the item to users who don't have this attribute. Users who have the attribute, but the value does not match that specified in the condition, will not see the item. false — users who have the attribute, but the value does not match that specified in the condition, or the attribute is missing, will not see the item.

itemsArray of objectsrequired
items[].​item_idnumber

Item ID.

items[].​skustring

Item SKU.

items[].​namestring

Item name.

items[].​typestring

Item type.

Enum"virtual_good""virtual_currency""bundle""physical_good""unit"
items[].​bundle_typestring

Bundle type. Returned if item type is a bundle.

Enum"standard""virtual_currency_package"
Response
application/json
{
  "rule_id": 1,
  "name": "Ork race armor rule",
  "is_enabled": true,
  "is_satisfied_for_unauth": true,
  "attribute_conditions": [
    { … }
  ],
  "items": [
    { … }
  ]
}

Update catalog filter ruleServer-sideAdmin

Request

Updates a specific rule applying to user attributes. The default value will be used for a not specified property (if property is not required).

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
rule_idnumberrequired

Rule ID.

Example: 1
Bodyapplication/json
namestring[ 1 .. 255 ] characters^\Srequired

Readable name of a rule. Used to display a rule in Publisher Account.

is_enabledbooleanrequired

If rule is enabled.

is_satisfied_for_unauthboolean

Whether the item is displayed to unauthorized users. If true, the item is displayed to the unauthorized user regardless of catalog display rules. false by default.

attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(personalized-catalog_user-attribute_conditions_model-post)[ 1 .. 100 ] itemsrequired

Conditions for validating user attributes. Determine item availability in the catalog based on whether user attributes match all specified conditions.

One of:
attribute_conditions[].​attributestring(user-attribute_conditions_properties_attribute)[ 1 .. 255 ] characters^[-_.\d\w]+$required

User attribute code.

attribute_conditions[].​typestring(user-attribute_conditions_properties_type-string)required

User attribute type.

Value"string"
attribute_conditions[].​operatorstring(user-attribute_conditions_properties_operator_string)required

Type of operation performed by condition. For string attribute type.

Enum ValueDescription
eq

Equals

ne

Not equals

attribute_conditions[].​valuestring(user-attribute_conditions_properties_value)<= 255 charactersrequired

Condition value which user attribute value will be compared to. Type depends on attribute type.

attribute_conditions[].​can_be_missingboolean(user-attribute_conditions_properties_can_be_missing)

Indicates that the condition is met even if attribute is missing from user attributes. Pass true to show the item to users who don't have this attribute. Users who have the attribute, but the value does not match that specified in the condition, will not see the item. false — users who have the attribute, but the value does not match that specified in the condition, or the attribute is missing, will not see the item.

itemsArray of objects[ 1 .. 100 ] itemsrequired
One of:

Items which are shown to a user if their attribute values meet conditions.

items[].​item_idnumberrequired

Item ID.

curl -i -X PUT \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/user/attribute/rule/1 \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Ork race armor rule",
    "is_enabled": true,
    "attribute_conditions": [
      {
        "attribute": "race",
        "operator": "eq",
        "value": "ork",
        "type": "string",
        "can_be_missing": false
      }
    ],
    "items": [
      {
        "item_id": 1
      }
    ],
    "is_satisfied_for_unauth": false
  }'

Responses

Successful update.

Response
No content

Management

Operations

Admin

Operations

Client

Operations

Clans client

Operations

Admin

Operations

Client

Operations

Admin

Operations

Client

Operations

Admin

Operations

Client

Operations