Skip to content
/
Delete offer chain

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

Client

Operations

Clans client

Operations

Admin

Operations

Client

Operations

Admin

Operations

Update offer chainServer-sideAdmin

Request

Updates a particular offer chain.

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
offer_chain_idintegerrequired

Offer chain ID.

Example: 101
Bodyapplication/json
idinteger(offer_chain_id)

Unique offer chain ID.

Example: 9
name(two-letter (object or null)) or (five-letter (object or null))(name-localization-object)required

Object with localizations for item’s name. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character language codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.

One of:

Object with localizations for item’s name. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character language codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.

name.​enstring or null

English

name.​arstring or null

Arabic

name.​bgstring or null

Bulgarian

name.​cnstring or null

Chinese (Simplified)

name.​csstring or null

Czech

name.​destring or null

German

name.​esstring or null

Spanish (Spain)

name.​frstring or null

French

name.​hestring or null

Hebrew

name.​itstring or null

Italian

name.​jastring or null

Japanese

name.​kostring or null

Korean

name.​plstring or null

Polish

name.​ptstring or null

Portuguese

name.​rostring or null

Romanian

name.​rustring or null

Russian

name.​thstring or null

Thai

name.​trstring or null

Turkish

name.​twstring or null

Chinese (Traditional)

name.​vistring or null

Vietnamese

name.​kmstring or null

Khmer

name.​idstring or null

Indonesian

name.​lostring or null

Lao

name.​mystring or null

Burmese

name.​phstring or null

Filipino

name.​nestring or null

Nepali

orderinteger(order)

Defines arrangement order.

Example: 1
description(two-letter (object or null)) or (five-letter (object or null))(description-localization-object)

Object with localizations for item’s description. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character locale codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.

One of:

Object with localizations for item’s description. Accepts value in one of two formats: two-letter lowercase language codes (e.g., en) or five-character locale codes (e.g., en-US). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., en and en-US), the last provided value is stored. You can find the full list of supported languages in the documentation.

date_startstring(date-time)(offer_chain_date_start)required

Date when the offer chain starts.

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

Date when the offer chain ends. Can be null. If date_end is null, the offer chain will not have a time limit.

Example: "2020-04-15T18:16:00+05:00"
is_enabledboolean(is_enabled)required
Example: true
recurrent_schedule(interval_type = weekly (object or null)) or (interval_type = monthly (object or null)) or (interval_type = hourly (object or null))(offer_chain_recurrent_schedule_create_update)

Reset period of the offer chain.

One of:

Weekly reset of the offer chain.

stepsArray of objects(modify-offer-chain-step-model)required
steps[].​step_idinteger or null(update_step_id)>= 1

Unique chain step ID. Specify it during update to retain user progress for this step.

Example: 10
steps[].​step_numberinteger(offer_chain_step_number)>= 1required

Step number.

Example: 2
steps[].​is_freeboolean(offer_chain_is_free)required

Indicates whether the offer chain step is free:

steps[].​itemsArray of objects(modify-offer-chain-item-model)non-emptyrequired
steps[].​items[].​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"
steps[].​items[].​quantityinteger>= 1required

Reward item quantity for this chain step.

steps[].​items[].​orderinteger or null>= 0

Reward order for the offer chain step.

is_always_visibleboolean(chain_is_always_visible)

Whether the chain is visible to all users:

  • If true, the chain is always displayed, regardless of the user's authentication status or attributes.
  • If false, the chain is displayed only if no personalized chain is found. For example, if the user is not authenticated or their attributes don’t match any personalized chain.

Applies only in the context of personalized chains and is used if the attribute_conditions array is not passed.

Default true
Example: true
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(chain_user-attribute_conditions_model-post)[ 1 .. 100 ] items

Conditions for validating user attributes. Determine chain availability based on whether user attributes match all specified conditions.

curl -i -X PUT \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/offer_chain/id/101 \
  -H 'Content-Type: application/json' \
  -d '{
    "name": {
      "en": "Updated offer chain",
      "ru": "Обновляемая цепочка предложений",
      "de": "Aktualisierte Angebotskette",
      "fr": "Chaîne d'\''offres mise à jour",
      "it": "Catena di offerte aggiornata"
    },
    "description": {
      "en": "A short description of a regular offer chain",
      "ru": "Краткое описание обычной цепочки предложений",
      "de": "Eine kurze Beschreibung einer regulären Angebotskette",
      "fr": "Une brève description d'\''une chaîne d'\''offres régulière",
      "it": "Una breve descrizione di una catena di offerte regolare"
    },
    "order": 4,
    "date_start": "2023-04-15T18:16:00+05:00",
    "date_end": null,
    "recurrent_schedule": null,
    "is_enabled": true,
    "steps": [
      {
        "step_id": 10,
        "step_number": 1,
        "is_free": false,
        "items": [
          {
            "sku": "chain_step_1_paid_bundle_sku",
            "quantity": 2
          }
        ]
      },
      {
        "step_number": 2,
        "is_free": true,
        "items": [
          {
            "sku": "chain_step_2_free_virtual_good_sku",
            "quantity": 1
          }
        ]
      },
      {
        "step_number": 3,
        "is_free": false,
        "items": [
          {
            "sku": "chain_step_3_paid_virtual_currency_package_sku",
            "quantity": 5
          }
        ]
      },
      {
        "step_id": 9,
        "step_number": 4,
        "is_free": true,
        "items": [
          {
            "sku": "chain_step_4_free_bundle_sku",
            "quantity": 1
          }
        ]
      }
    ],
    "is_always_visible": true
  }'

Responses

Offer chain was successfully updated.

Body
Response
No content

Delete offer chainServer-sideAdmin

Request

Deletes a particular offer chain.

After deletion:

  • All rewards already received by users are retained.
  • Uncompleted steps become unavailable, and their rewards can no longer be obtained.

Unlike disabling the offer chain via the Toggle offer chain call, deletion is irreversible and user progress is not preserved.

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
offer_chain_idintegerrequired

Offer chain ID.

Example: 101
curl -i -X DELETE \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/offer_chain/id/101

Responses

Offer chain was successfully deleted.

Body
Response
No content

Toggle offer chainServer-sideAdmin

Request

Enables or disables an offer chain.

When the offer chain is disabled, users temporarily lose access to it, but their progress is preserved.

After the offer chain is re-enabled, users can continue from the step where they left off.

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
offer_chain_idintegerrequired

Offer chain ID.

Example: 101
curl -i -X PUT \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/offer_chain/id/101/toggle

Responses

The offer chain has been disabled/enabled.

Body
Response
No content

Client

Operations

Admin

Operations

Client

Operations