` — это токен пользователя. Токен идентифицирует пользователя и предоставляет доступ к персонализированным данным. В качестве альтернативы вы можете использовать [токен для открытия платежного интерфейса](/ru/api/pay-station/token/create-token).\n\n2. Упрощенный режим без заголовка. Он применяется только для неавторизованных пользователей и может быть использована только для [продажи игровых ключей](/ru/doc/buy-button/how-to/set-up-authentication/#guides_buy_button_selling_items_not_authenticated_users). Вместо токена в запрос передаются заголовки:\n - `x-unauthorized-id` с ID запроса;\n - `x-user` с email пользователя, закодированным в формате Base64.\n\n## Полезные ссылки\n\n- [Методы API по модели взаимодействия](https://developers.xsolla.com/ru/api/catalog/)\n- [Команды управления ресурсами](https://developers.xsolla.com/ru/api/catalog/)\n- [Обработка ошибок](https://developers.xsolla.com/ru/api/catalog/)\n- [Управление ключами API](https://developers.xsolla.com/ru/api/catalog/)\n\n# Базовая структура товара\n\nТовары всех типов (виртуальные предметы, бандлы, виртуальная валюта, ключи) используют схожую структуру данных. Понимание базовой структуры упрощает работу с API и позволяет быстрее ориентироваться в документации.\n\nПримечание
В некоторых методах могут использоваться дополнительные поля, но они не изменяют базовую структуру.
\n\n**Идентификация**\n\n- `merchant_id` — ID компании в [Личном кабинете](https://publisher.xsolla.com/);\n- `project_id` — ID проекта в Личном кабинете;\n- `sku` — артикул товара, уникальный в рамках проекта.\n\n**Отображение в каталоге**\n\n- `name` — название;\n- `description` — описание;\n- `image_url` — ссылка на изображение;\n- `is_enabled` — доступность товара;\n- `is_show_in_store` — отображение в каталоге.\n\nПодробнее об управлении доступностью товаров в каталоге – в [документации](/ru/items-catalog/catalog-features/items-availability/).\n\n**Организация**\n\n- `type` — тип товара, например, виртуальный предмет (`virtual_item`) или бандл (`bundle`);\n- `groups` — группы, к которым относится товар;\n- `order` — порядок отображения в каталоге.\n\n**Условия продажи**\n\n- `prices` — цены в реальной или виртуальной валюте;\n- `limits` — ограничения на покупку;\n- `periods` — период доступности;\n- `regions` — региональные ограничения.\n\n**Пример базовой структуры:**\n\n```json\n{\n \"attributes\": [],\n \"bundle_type\": \"virtual_currency_package\",\n \"content\": [\n {\n \"description\": {\n \"en\": \"Main in-game currency\"\n },\n \"image_url\": \"https://.../image.png\",\n \"name\": {\n \"en\": \"Crystals\",\n \"de\": \"Kristalle\"\n },\n \"quantity\": 500,\n \"sku\": \"com.xsolla.crystal_2\",\n \"type\": \"virtual_currency\"\n }\n ],\n \"description\": {\n \"en\": \"Crystals x500\"\n },\n \"groups\": [],\n \"image_url\": \"https://.../image.png\",\n \"is_enabled\": true,\n \"is_free\": false,\n \"is_show_in_store\": true,\n \"limits\": {\n \"per_item\": null,\n \"per_user\": null,\n \"recurrent_schedule\": null\n },\n \"long_description\": null,\n \"media_list\": [],\n \"name\": {\n \"en\": \"Medium crystal pack\"\n },\n \"order\": 1,\n \"periods\": [\n {\n \"date_from\": null,\n \"date_until\": \"2020-08-11T20:00:00+03:00\"\n }\n ],\n \"prices\": [\n {\n \"amount\": 20,\n \"country_iso\": \"US\",\n \"currency\": \"USD\",\n \"is_default\": true,\n \"is_enabled\": true\n }\n ],\n \"regions\": [],\n \"sku\": \"com.xsolla.crystal_pack_2\",\n \"type\": \"bundle\",\n \"vc_prices\": []\n}\n```\n\n# Настройка продажи товаров\n\nXsolla API позволяет реализовать логику магазина внутриигровых товаров, включая получение каталога, управление корзиной, создание заказов и отслеживание их статусов. В зависимости от сценария интеграции методы API делятся на подразделы **Admin** и **Catalog**, которые используют разные [схемы аутентификации](/ru/api/catalog/section/authentication).\n\nНиже приведен пример базового сценария настройки и работы магазина — от создания товаров до их продажи пользователю.\n\n## Создание товаров и групп (Admin)\n\nСоздайте каталог товаров для вашего магазина, например, виртуальные предметы, бандлы или виртуальную валюту.\n\nПримеры методов:\n- [Создать виртуальный предмет](/ru/api/catalog/virtual-items-currency-admin/admin-create-virtual-item)\n- [Создать бандл](/ru/api/catalog/bundles-admin/admin-create-bundle)\n- [Создать виртуальную валюту](/ru/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency)\n\n## Настройка акций, цепочек, ограничений (Admin)\n\nНастройте инструменты привлечения пользователей и монетизации, например скидки, бонусы, ежедневные награды или цепочки предложений.\n\nПримеры методов:\n- [Создать акцию с бонусами](/ru/api/liveops/promotions-bonuses/create-bonus-promotion)\n- [Создать ежедневную награду](/ru/api/liveops/daily-chain-admin/admin-create-daily-chain)\n- [Создать уникальное предложение по каталогу](/ru/api/liveops/promotions-unique-catalog-offers/admin-create-unique-catalog-offer)\n\n## Получение информации о товарах (Client)\n\nНастройте отображение товаров магазина в вашем приложении.\n\n\n
Внимание\n Не используйте методы подраздела Admin для построения каталога пользователям — у таких методов заданы ограничения по
частоте запросов, которые не рассчитаны на пользовательский трафик.\n
\n\nПримеры методов:\n- [Получение списка виртуальных предметов](/ru/api/catalog/virtual-items-currency-catalog/get-virtual-items)\n- [Получение списка групп товаров](/ru/api/catalog/virtual-items-currency-catalog/get-item-groups)\n- [Получение списка бандлов](/ru/api/catalog/bundles-catalog/get-bundle-list)\n- [Получение списка продаваемых товаров](/ru/api/catalog/common-catalog/get-sellable-items)\n\n\n Примечание
\n По умолчанию в методах получения каталога возвращаются товары, которые отображаются в магазине на момент запроса. Чтобы получить информацию о товарах, период отображения которых еще не наступил или уже истек, передайте параметр \"show_inactive_time_limited_items\": 1 при запросе каталога.\n
\n\n## Продажа товаров\n\nВы можете продавать товары за реальную валюту следующими способами:\n- Быстрая покупка — продажа одного товара, но в любом количестве.\n- Покупка корзины — пользователь наполняет корзину, добавляет и удаляет товары, изменяет количество в одном заказе.\n\nЕсли товар оплачивается внутриигровой валютой, а не реальными деньгами, используйте метод [Создание заказа с указанным товаром, приобретенным за виртуальную валюту](/ru/api/catalog/virtual-payment/create-order-with-item-for-virtual-currency). Платежный интерфейс открывать не нужно — списание происходит в момент вызова метода.\n\nЕсли товар бесплатный, используйте метод [Создание заказа с указанным бесплатным товаром](/ru/api/catalog/free-item/create-free-order-with-item) или метод [Создание заказа с помощью бесплатной корзины](/ru/api/catalog/free-item/create-free-order). Платежный интерфейс открывать не нужно — заказ сразу переходит в статус done.\n\n### Быстрая покупка\n\nИспользуйте клиентский [метод создания заказа с указанным товаром](/ru/api/catalog/payment-client-side/create-order-with-item) – в ответе вы получите токен, который используется для открытия платежного интерфейса.\n\n\n Примечание
\n Информация о скидке доступна пользователю только в платежном интерфейсе. Использование промокодов не предусмотрено.\n
\n\n### Покупка корзины\n\nНаполнение и покупка корзины может осуществляться на клиенте или на сервере.\n\n**Наполнение и покупка корзины на клиенте**\n\nСамостоятельно реализуйте логику добавления и удаления товаров. Также необходимо учитывать, что до вызова метода наполнения корзины у вас не будет информации о том, какие акции будут применены при покупке. Это означает, что итоговая стоимость и сведения о добавленных бонусных предметах будут неизвестны.\n\nРеализуйте следующую логику работы с корзиной:\n1. После наполнения корзины игроком используйте метод [Наполнение корзины товарами](/ru/api/shop-builder/operation/cart-fill/) для наполнения корзины. В ответе вернется текущая информация о выбранных товарах — цены до и после применения скидок, бонусные товары.\n2. Обновите содержимое корзины в соответствии с действиями пользователя:\n - Для добавления товара или изменения его количества используйте метод [Обновление товара в корзине по ID корзины](/ru/api/shop-builder/operation/put-item-by-cart-id/).\n - Для удаления товара используйте метод [Удаление товара из корзины по ID корзины](/ru/api/shop-builder/operation/delete-item-by-cart-id/).\n\n\n Примечание
\n Если вы хотите получить актуальное состояние корзины, используйте метод Получение корзины текущего пользователя.\n
\n\n3. Используйте метод покупки корзины [Создание заказа со всеми товарами из текущей корзины](/ru/api/shop-builder/operation/create-order/). В ответе вернутся ID заказа и платежный токен. Заказу будет присвоен статус new.\n\n**Наполнение и покупка корзины на сервере**\n\nЭтот вариант наполнения корзины может занимать значительное время на настройку, поскольку каждое изменение корзины может сопровождаться вызовом большего количества методов API.\n\nРеализуйте следующую логику работы с корзиной:\n1. После наполнения корзины игроком используйте методс [Наполнение корзины товарами](/ru/api/catalog/cart-server-side)для наполнения корзины. В ответе вернется текущая информация о выбранных товарах — цены до и после применения скидок, бонусные товары.\n2. Используйте метод покупки корзины [Создание заказа со всеми товарами из текущей корзины](/ru/api/shop-builder/operation/create-order/). В ответе вернутся ID заказа и платежный токен. Заказу будет присвоен статус new.\n\n## Открытие платежного интерфейса\n\nИспользуйте полученный токен для открытия платежного интерфейса в новом окне. Другие способы открытия платежного интерфейса описаны в [документации](/ru/payment-ui-and-flow/payment-ui/how-to-open-payment-ui/#open_payment_ui).\n\n| Действие | Эндпоинт |\n|:----------------------------------|:--------------------------------------------------------------------------|\n| Открыть в боевом окружении. | https://secure.xsolla.com/paystation4/?token={token} |\n| Открыть в тестовом окружении. | https://sandbox-secure.xsolla.com/paystation4/?token={token} |\n\n\n
Примечание\n Используйте тестовый режим (sandbox-режим) при разработке и тестировании — при совершении тестовой покупки с реальных счетов не списываются деньги. Для тестирования вы можете использовать
тестовые банковские карты.\n\n После проведения первого реального платежа в силу вступает строгая политика платежей в тестовом окружении. Проведение платежа в нем будет доступно только для пользователей, которые указаны в Личном кабинете в разделе [Настройки компании > Пользователи](https://publisher.xsolla.com/0/settings/users).\n\n Покупка виртуальной валюты и виртуальных предметов за реальную валюту возможна после подписания лицензионного договора с Xsolla. Для этого в [Личном кабинете](https://publisher.xsolla.com/) перейдите в **Договоры и налоги > Договоры**, заполните договор и дождитесь подтверждения согласования. Согласование может занять до 3 рабочих дней.\n
\n
Примечание
\n
Подробная информация о работе с купонами приведена в документации.
\n
\n
Примечание
\n
Подробная информация о работе с промокодами приведена в документации.
\n
\n
Примечание
\n
Подробная информация о работе с уникальным каталогом предложений приведена в документации.
\n
\n
Примечание
\n
Подробная информация о работе со скидками приведена в документации.
\n
\n
Примечание
\n
Подробная информация о работе с бонусами приведена в документации.
\n
\n
Примечание\n Вы можете использовать только один тип персонализации. Чтобы изменить его, используйте\n
инструкцию.\n
\n
Примечание\nПодробная информация приведена:\n
\n
\n\n\n Примечание
\n Этот метод использует JWT пользователя для авторизации.
\n Передайте токен в заголовке Authorization в формате: Bearer <user_JWT>. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода.\n
",
"operationId": "redeem-coupon",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"promotions-coupons"
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_redeem-coupon-model"
},
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-coupon-redeemed"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"403": {
"$ref": "#/components/responses/Promotions_403-auth-header"
},
"404": {
"$ref": "#/components/responses/Promotions_404-coupon"
},
"422": {
"$ref": "#/components/responses/Promotions_422-redeem-coupon"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
]
}
},
"/v2/project/{project_id}/coupon/code/{coupon_code}/rewards": {
"get": {
"summary": "Получение вознаграждений по купону",
"description": "Получает вознаграждения по купону по его коду.\nМожет использоваться, чтобы дать пользователям возможность выбрать один предмет из множества в качестве бонуса.\nСтандартный случай — выбор DRM, если купон содержит игру в качестве бонуса (`type=unit`).
\n\n\n Примечание
\n Этот метод использует JWT пользователя для авторизации.
\n Передайте токен в заголовке Authorization в формате: Bearer <user_JWT>. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода.\n
",
"operationId": "get-coupon-rewards-by-code",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/coupon_code-path-param"
}
],
"tags": [
"promotions-coupons"
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-coupon-rewards"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"403": {
"$ref": "#/components/responses/Promotions_403-auth-header"
},
"404": {
"$ref": "#/components/responses/Promotions_404-coupon"
},
"422": {
"$ref": "#/components/responses/Promotions_422-rewards"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
]
}
},
"/v3/project/{project_id}/admin/coupon": {
"post": {
"summary": "Создание акции с купонами",
"description": "Создает акцию с купонами.",
"operationId": "admin-create-coupon",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"promotions-coupons"
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_coupon-create"
},
"responses": {
"201": {
"description": "Акция с купонами создана успешно.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/Promotions_coupon-external_id"
}
}
},
"examples": {
"response": {
"value": {
"external_id": "coupon_external_id"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-invalid-coupon"
}
}
},
"get": {
"tags": [
"promotions-coupons"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "get-coupons",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"summary": "Получение списка акций с купонами",
"description": "Получает список акций с купонами в рамках проекта.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-get-coupons"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
}
}
}
},
"/v3/project/{project_id}/admin/coupon/{external_id}": {
"put": {
"summary": "Обновление акции с купонами",
"description": "Обновляет акцию с купонами.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"tags": [
"promotions-coupons"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "update-coupon-promotion",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_coupon-update"
},
"responses": {
"204": {
"description": "Акция с купонами обновлена успешно."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
},
"422": {
"$ref": "#/components/responses/Promotions_422-invalid-coupon"
}
}
},
"get": {
"tags": [
"promotions-coupons"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "get-coupon",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"summary": "Получение акции с купонами",
"description": "Получает указанную акцию с купонами.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"200": {
"description": "Акция с купонами получена успешно.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/admin-promotions_200-get-coupon-promotion-model"
},
"examples": {
"response": {
"value": {
"external_id": "summer20221",
"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": "Coupon name",
"ru-RU": "Название купона"
},
"is_enabled": true,
"bonus": [
{
"sku": "com.xsolla.diamonds_1",
"quantity": 100
}
],
"redeem_user_limit": null,
"redeem_total_limit": 100,
"redeem_code_limit": null,
"total_limit_state": {
"available": 50,
"reserved": 10,
"used": 40
}
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
}
}
},
"delete": {
"summary": "Удаление акции с купонами",
"description": "Удаляет [акцию с купонами](https://developers.xsolla.com/ru/doc/shop-builder/features/coupons/). Удаленная акция:\n* Пропадет из списка акций, настроенных в вашем проекте.\n* Не будет применяться к каталогу товаров. Пользователь не сможет получить бонусные товары по этой акции.\n\nПосле удаления акция не может быть восстановлена.\nКоды купонов из удаленной акции могут быть [добавлены](https://developers.xsolla.com/ru/api/shop-builder/operation/create-coupon-code/) в существующие акции.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"tags": [
"promotions-coupons"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "delete-coupon-promotion",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"responses": {
"204": {
"description": "Акция с купоном удалена успешно."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
}
}
}
},
"/v2/project/{project_id}/admin/coupon/{external_id}/activate": {
"put": {
"summary": "Активация акции с купонами",
"description": "Активирует акцию с купонами.\n После создания акция с купонами по умолчанию отключена.\n Погашение по акции не будет доступно, пока вы ее не активируете.\n Используйте данный метод, чтобы включить и активировать акцию с купонами.",
"operationId": "activate-coupon",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"tags": [
"promotions-coupons"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"204": {
"description": "Купон активирован успешно."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
},
"422": {
"$ref": "#/components/responses/Promotions_422-admin-promotion-error"
}
}
}
},
"/v2/project/{project_id}/admin/coupon/{external_id}/deactivate": {
"put": {
"summary": "Деактивация акции с купонами",
"description": "Деактивирует акцию с купонами.\n После создания акция с купонами по умолчанию отключена.\n Погашение по акции не будет доступно, пока вы ее не активируете.\n Используйте данный метод, чтобы выключить и деактивировать акцию с купонами.",
"operationId": "deactivate-coupon",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"tags": [
"promotions-coupons"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"204": {
"description": "Купон деактивирован успешно."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
},
"422": {
"$ref": "#/components/responses/Promotions_422-admin-promotion-error"
}
}
}
},
"/v2/project/{project_id}/admin/coupon/{external_id}/code": {
"post": {
"operationId": "create-coupon-code",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"summary": "Создание кода купона",
"description": "Создает код купона.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"tags": [
"promotions-coupons"
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_create-coupon-promocode-code"
},
"responses": {
"201": {
"$ref": "#/components/responses/Promotions_201-coupon-promocode-code-created"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
},
"422": {
"$ref": "#/components/responses/Promotions_422-coupon-promocode-same-code-exists"
}
}
},
"get": {
"operationId": "get-coupon-codes",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"summary": "Получение кодов купонов",
"description": "Получает коды купонов.\n\nВ ответе возвращается общее количество кодов в акции (`total_count`) и коды на текущей странице (`codes`). Чтобы получить коды со следующей страницы, увеличьте значение параметра `offset` на величину `limit` (например, `“offset”: 100`, затем `“offset”: 200`) до получения всех кодов.\n\nВ большинстве случаев достаточно `“limit”: 100` или `“limit”: 1000`. Для разовой массовой выгрузки допустимо `“limit”: 10000`. Не используйте без необходимости большие значения, например, `“limit”: 50000`.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"promotions-coupons"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-coupon-code-list"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
}
}
}
},
"/v2/project/{project_id}/admin/coupon/{external_id}/code/generate": {
"put": {
"summary": "Генерация кодов купонов",
"description": "Генерирует коды купонов.\n\nРекомендации по работе с кодами:\n\n* Для одной акции нет ограничений на количество кодов. Однако вы можете создать максимум 50 000 кодов за один запрос. Запросы на большее количество кодов вернут ошибку `422 Unprocessable Entity`. Если вам нужно создать больше 50 000 кодов, отправьте несколько запросов.\n\n* Для большей стабильности мы рекомендуем создавать коды частями, до 10 000 за один запрос. Например, чтобы создать 100 000 кодов, отправьте 10 запросов с `\"count\": 10000`, а не 2 запроса с `\"count\": 50000`. Дождитесь успешного ответа на каждый запрос прежде чем отправлять следующий.\n\n* Обратите внимание на ограничение на отправку запросов — не больше 15 в секунду. При создании большого количества кодов отправляйте запросы последовательно, чтобы не превысить ограничение в 15 секунд и избежать ошибки `429`.\n\n* Чтобы получить список кодов, используйте метод [Получение кодов купонов](/ru/api/liveops/promotions-coupons/get-coupon-codes).\n\n| Показатель | Значение |\n|---|---|\n| Минимальное количество кодов в запросе. | 1 |\n| Максимальное количество кодов в запросе. Используйте только если вам необходимо создать максимальное количество кодов за один запрос. | 50 000 |\n| Рекомендованное количество кодов в запросе. | До 10 000. Если необходимо создать больше кодов, отправьте несколько последовательных запросов. |",
"operationId": "generate-coupon-codes",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"tags": [
"promotions-coupons"
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"$ref": "#/components/schemas/Promotions_coupon-generate-count"
}
},
"required": [
"count"
]
}
}
}
},
"responses": {
"200": {
"description": "Коды успешно сгенерированы.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"$ref": "#/components/schemas/Promotions_coupon-generate-count"
}
}
},
"examples": {
"response": {
"value": {
"count": 10
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
}
}
}
},
"/v2/project/{project_id}/promocode/redeem": {
"post": {
"summary": "Погашение промокода",
"description": "Использует код акции с промокодами.\nПосле погашения промокода пользователь получит бесплатные товары и/или цена корзины и/или отдельных товаров будет снижена.",
"operationId": "redeem-promo-code",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"promotions-promo-codes"
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_redeem-promo-code-model"
},
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-promo-code-redeemed"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"403": {
"$ref": "#/components/responses/Promotions_403-auth-header"
},
"404": {
"$ref": "#/components/responses/Promotions_404-promo-code"
},
"422": {
"$ref": "#/components/responses/Promotions_422-redeem-coupon"
}
},
"security": [
{
"AuthForCart": []
}
]
}
},
"/v2/project/{project_id}/promocode/remove": {
"put": {
"summary": "Удаление промокода из корзины",
"description": "Удаляет промокод из корзины.\nПосле удаления промокода общая цена всех товаров в корзине будет пересчитана без учета бонусов и скидок, предоставляемых промокодом.",
"operationId": "remove-cart-promo-code",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"promotions-promo-codes"
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_cancel-promo-code-model"
},
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-promo-code-canceled"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"403": {
"$ref": "#/components/responses/Promotions_403-auth-header"
},
"422": {
"$ref": "#/components/responses/Promotions_422-cancel-promo-code"
}
},
"security": [
{
"AuthForCart": []
}
]
}
},
"/v2/project/{project_id}/promocode/code/{promocode_code}/rewards": {
"get": {
"summary": "Получение вознаграждения по промокоду",
"description": "Получает награды промокодов по их коду.\nМожет использоваться для того, чтобы позволить пользователям выбрать один из множества предметов в качестве бонуса.\nСтандартный случай — выбор DRM, если промокод содержит игру в качестве бонуса (`type=unit`).
.\n\n\n Примечание
\n Этот метод использует JWT пользователя для авторизации.
\n Передайте токен в заголовке Authorization в формате: Bearer <user_JWT>. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода.\n
",
"operationId": "get-promo-code-rewards-by-code",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promocode_code-path-param"
}
],
"tags": [
"promotions-promo-codes"
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-promocode-rewards"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"403": {
"$ref": "#/components/responses/Promotions_403-auth-header"
},
"404": {
"$ref": "#/components/responses/Promotions_404-promo-code"
},
"422": {
"$ref": "#/components/responses/Promotions_422-rewards"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
]
}
},
"/v3/project/{project_id}/admin/promocode": {
"post": {
"operationId": "create-promo-code",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"summary": "Создание акции с промокодами",
"description": "Создает акцию с промокодами.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"promotions-promo-codes"
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_promocode-create"
},
"responses": {
"201": {
"description": "Промокод создан успешно.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/Promotions_coupon-external_id"
}
}
},
"examples": {
"response": {
"value": {
"external_id": "coupon_external_id"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-invalid-coupon"
}
}
},
"get": {
"tags": [
"promotions-promo-codes"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "get-promo-codes",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"summary": "Получение списка акций с промокодами",
"description": "Получает список промокодов проекта.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-get-promocodes"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
}
}
}
},
"/v3/project/{project_id}/admin/promocode/{external_id}": {
"put": {
"summary": "Обновление акции с промокодами",
"description": "Обновляет акцию с промокодами.",
"operationId": "update-promo-code",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"tags": [
"promotions-promo-codes"
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_promocode-update"
},
"responses": {
"204": {
"description": "Промокод обновлен успешно."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
},
"422": {
"$ref": "#/components/responses/Promotions_422-invalid-coupon"
}
}
},
"get": {
"tags": [
"promotions-promo-codes"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "get-promo-code",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"summary": "Получение акции с промокодами",
"description": "Получает указанную акцию с промокодами.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"200": {
"description": "Промокод получен успешно.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Promotions_200-get-promocode-promotion-model"
},
"examples": {
"simple": {
"value": {
"external_id": "summer20221",
"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": "Coupon name",
"ru-RU": "Название купона"
},
"is_enabled": true,
"bonus": [
{
"sku": "com.xsolla.diamonds_1",
"quantity": 100
}
],
"redeem_user_limit": null,
"redeem_total_limit": 100,
"redeem_code_limit": 1,
"discount": {
"percent": "10.99"
},
"discounted_items": null,
"total_limit_state": {
"available": 50,
"reserved": 10,
"used": 40
},
"excluded_promotions": [
23,
45
]
}
},
"with price conditions": {
"value": {
"external_id": "summer20221",
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"name": {
"en-US": "Coupon name",
"ru-RU": "Название купона"
},
"is_enabled": true,
"bonus": [
{
"sku": "com.xsolla.diamonds_2",
"quantity": 100
}
],
"redeem_user_limit": null,
"redeem_total_limit": 100,
"redeem_code_limit": 1,
"discount": {
"percent": "10.99"
},
"discounted_items": null,
"total_limit_state": {
"available": 50,
"reserved": 10,
"used": 40
},
"price_conditions": [
{
"operator": "gt",
"value": "10.0000"
},
{
"operator": "lt",
"value": "50.0000"
}
]
}
},
"with item price conditions": {
"value": {
"external_id": "summer20221",
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"name": {
"en-US": "Coupon name",
"ru-RU": "Название купона"
},
"is_enabled": true,
"bonus": [
{
"sku": "com.xsolla.diamonds_3",
"quantity": 100
}
],
"redeem_user_limit": null,
"redeem_total_limit": 100,
"redeem_code_limit": 1,
"discount": {
"percent": "10.99"
},
"discounted_items": null,
"total_limit_state": {
"available": 50,
"reserved": 10,
"used": 40
},
"item_price_conditions": [
{
"operator": "gt",
"value": "10.0000"
},
{
"operator": "lt",
"value": "50.0000"
}
],
"excluded_promotions": [
23,
45
]
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
}
}
},
"delete": {
"summary": "Удаление акции с промокодами",
"description": "Удаляет [акцию с промокодами](https://developers.xsolla.com/ru/doc/shop-builder/features/promo-codes/). Удаленная акция:\n* Пропадет из списка акций, настроенных в вашем проекте.\n* Не будет применяться к каталогу товаров и к корзине. Пользователь не сможет получить бонусные товары или купить товары с применением этой акции.\n\nПосле удаления акция не может быть восстановлена.\nПромокоды из удаленной акции могут быть [добавлены](https://developers.xsolla.com/ru/api/shop-builder/operation/create-promo-code-code/) в существующие акции.",
"operationId": "delete-promo-code",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"tags": [
"promotions-promo-codes"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"204": {
"description": "Акция с промокодом была удалена успешно."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
}
}
}
},
"/v2/project/{project_id}/admin/promocode/{external_id}/activate": {
"put": {
"summary": "Активация акции с промокодами",
"description": "Активирует акцию с промокодами.\n\nПосле создания акция с промокодами по умолчанию отключена.\n Погашение по акции не будет доступно, пока вы ее не активируете.\n Используйте данный метод, чтобы включить и активировать акцию с промокодами.",
"operationId": "activate-promo-code",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"tags": [
"promotions-promo-codes"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"204": {
"description": "Промокод активирован успешно."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
},
"422": {
"$ref": "#/components/responses/Promotions_422-admin-promotion-error"
}
}
}
},
"/v2/project/{project_id}/admin/promocode/{external_id}/deactivate": {
"put": {
"summary": "Деактивация акции с промокодами",
"description": "Деактивирует акцию с промокодами.\n\nПосле создания акция с промокодами по умолчанию отключена.\n Погашение по акции не будет доступно, пока вы ее не активируете.\n Используйте данный метод, чтобы выключить и деактивировать акцию с промокодами.",
"operationId": "deactivate-promo-code",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"tags": [
"promotions-promo-codes"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"204": {
"description": "Купон деактивирован успешно."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
},
"422": {
"$ref": "#/components/responses/Promotions_422-admin-promotion-error"
}
}
}
},
"/v2/project/{project_id}/admin/promocode/{external_id}/code": {
"post": {
"operationId": "create-promo-code-code",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"summary": "Создание кода для акции с промокодами",
"description": "Создает код для акции с промокодами.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"tags": [
"promotions-promo-codes"
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_create-coupon-promocode-code"
},
"responses": {
"201": {
"$ref": "#/components/responses/Promotions_201-coupon-promocode-code-created"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
},
"422": {
"$ref": "#/components/responses/Promotions_422-coupon-promocode-same-code-exists"
}
}
},
"get": {
"operationId": "get-promocode-codes",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"summary": "Получение кодов акции с промокодами",
"description": "Получает коды акции с промокодами.\n\nВ ответе возвращается общее количество кодов в акции (`total_count`) и коды на текущей странице (`codes`). Чтобы получить коды со следующей страницы, увеличьте значение параметра `offset` на величину `limit` (например, `“offset”: 100`, затем `“offset”: 200`) до получения всех кодов.\n\nВ большинстве случаев достаточно `“limit”: 100` или `“limit”: 1000`. Для разовой массовой выгрузки допустимо `“limit”: 10000`. Не используйте без необходимости большие значения, например, `“limit”: 50000`.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"promotions-promo-codes"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-promocode-code-list"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
}
}
}
},
"/v2/project/{project_id}/admin/promocode/{external_id}/code/generate": {
"put": {
"summary": "Генерация кодов для акции с промокодами",
"description": "Генерирует коды для акции с промокодами.\n\nРекомендации по работе с кодами:\n\n* Для одной акции нет ограничений на количество кодов. Однако вы можете создать максимум 50 000 кодов за один запрос. Запросы на большее количество кодов вернут ошибку `422 Unprocessable Entity`. Если вам нужно создать больше 50 000 кодов, отправьте несколько запросов.\n\n* Для большей стабильности мы рекомендуем создавать коды частями, до 10 000 за один запрос. Например, чтобы создать 100 000 кодов, отправьте 10 запросов с `\"count\": 10000`, а не 2 запроса с `\"count\": 50000`. Дождитесь успешного ответа на каждый запрос прежде чем отправлять следующий.\n\n* Обратите внимание на ограничение на отправку запросов — не больше 15 в секунду. При создании большого количества кодов отправляйте запросы последовательно, чтобы не превысить ограничение в 15 секунд и избежать ошибки `429`.\n\nЧтобы получить список кодов, используйте метод [Получение кодов акции с промокодами](/ru/api/liveops/promotions-promo-codes/get-promocode-codes).\n\n| Показатель | Значение |\n|---|---|\n| Минимальное количество кодов в запросе. | 1 |\n| Максимальное количество кодов в запросе. Используйте только если вам необходимо создать максимальное количество кодов за один запрос. | 50 000 |\n| Рекомендованное количество кодов в запросе. | До 10 000. Если необходимо создать больше кодов, отправьте несколько последовательных запросов. |",
"operationId": "generate-promo-code-codes",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"tags": [
"promotions-promo-codes"
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"$ref": "#/components/schemas/Promotions_coupon-generate-count"
}
},
"required": [
"count"
]
}
}
}
},
"responses": {
"200": {
"description": "Коды успешно сгенерированы.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"$ref": "#/components/schemas/Promotions_coupon-generate-count"
}
}
},
"examples": {
"response": {
"value": {
"count": 10
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
}
}
}
},
"/v3/project/{project_id}/admin/promotion/item": {
"post": {
"summary": "Создание акции со скидками для товара",
"description": "Создает акцию со скидками для товара.\n\nАкция дает скидку (%) на товары.\nСкидка будет применена ко всем ценам на указанные товары.",
"operationId": "create-item-promotion",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"promotions-discounts"
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_create-update-item-promotion"
},
"responses": {
"201": {
"$ref": "#/components/responses/Promotions_201-create-promotion"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-admin-promotion-missed-items-property"
}
}
},
"get": {
"tags": [
"promotions-discounts"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "get-item-promotion-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"summary": "Получение списка акций со скидками",
"description": "Получает список акций со скидками в рамках проекта.\n\nАкция дает скидку (%) на товары.\nСкидка будет применена ко всем ценам на указанные товары.",
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"description": "ID проекта.",
"schema": {
"type": "integer",
"default": 59080
}
},
{
"name": "limit",
"in": "query",
"required": false,
"description": "Лимит количества элементов на странице.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"description": "Номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0).",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-get-item-promotions"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
}
}
}
},
"/v3/project/{project_id}/admin/promotion/{promotion_id}/item": {
"put": {
"tags": [
"promotions-discounts"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "update-item-promotion",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"summary": "Обновление акции со скидками",
"description": "Обновляет акцию.\n\nПримечание
Новые данные заменят старые. Если вы хотите обновить только часть акции, вам также следует передать в запросе все необходимые данные.
\n\nАкция дает скидку (%) на товары.\nСкидка будет применена ко всем ценам на указанные товары.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"responses": {
"204": {
"description": "Акция обновлена успешно."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promotion"
},
"422": {
"$ref": "#/components/responses/Promotions_422-admin-promotion-missed-items-property"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_create-update-item-promotion"
}
},
"get": {
"tags": [
"promotions-discounts"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "get-item-promotion",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"summary": "Получение акции со скидками",
"description": "Получает акцию, применяемую к определенным товарам.\n\nАкция дает скидку (%) на товары.\nСкидка будет применена ко всем ценам на указанные товары.",
"responses": {
"200": {
"description": "Акция со скидками получена успешно.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID акции. Уникальный идентификатор акции в рамках проекта."
},
"promotion_periods": {
"$ref": "#/components/schemas/promotion_periods"
},
"is_enabled": {
"$ref": "#/components/schemas/Promotions_is_enabled"
},
"name": {
"type": "object",
"description": "Название акции. Данный параметр должен содержать пары ключ/значение,\n где ключ — это локаль в формате \"^[a-z]{2}-[A-Z]{2}$\", значение — строка.",
"additionalProperties": {
"type": "string",
"example": {
"en-US": "Promotion",
"ru-RU": "Акция"
}
}
},
"discount": {
"type": "object",
"properties": {
"percent": {
"type": [
"string",
"null"
],
"description": "Процент скидки.\nЦена товара будет уменьшена с использованием значения, рассчитанного с использованием этого процента.",
"default": "10.00"
}
}
},
"items": {
"type": [
"array",
"null"
],
"items": {
"description": "Список товаров, на которые будет распространяться скидка.",
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "Артикул товара.",
"default": "elven_sword"
}
}
}
},
"attribute_conditions": {
"$ref": "#/components/schemas/promotion_user-attribute_conditions_model-get"
},
"limits": {
"$ref": "#/components/schemas/Promotions_promotion_limits_response"
},
"price_conditions": {
"$ref": "#/components/schemas/price_conditions_discount"
},
"excluded_promotions": {
"$ref": "#/components/schemas/excluded_promotions"
}
},
"example": {
"id": 1,
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"is_enabled": true,
"discount": {
"percent": "15.00"
},
"items": [
{
"sku": "com.xsolla.elven_sword_1"
},
{
"sku": "com.xsolla.elven_helmet_1"
},
{
"sku": "com.xsolla.elven_armor_1"
}
],
"name": {
"en-US": "Promotion",
"ru-RU": "Акция"
}
}
},
"examples": {
"response": {
"value": {
"id": 1,
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"is_enabled": true,
"discount": {
"percent": "20.00"
},
"items": [
{
"sku": "com.xsolla.elven_helmet_1"
},
{
"sku": "com.xsolla.elven_armor_1"
}
],
"name": {
"en-US": "Promotion",
"ru-RU": "Акция"
},
"limits": {
"per_user": {
"total": 10
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"day_of_week": null,
"day_of_month": null,
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"price_conditions": [
{
"operator": "ge",
"value": "10.0000"
},
{
"operator": "le",
"value": "50.0000"
}
],
"excluded_promotions": [
23,
45
]
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"description": "Акция не найдена. Убедитесь, что верно указали `promotion_id`.",
"content": {
"application/json": {
"schema": {
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 9502
},
"errorMessage": {
"type": "string",
"example": "[0401-9502]: Can not find promotion with ID = 111425 in project 59080"
}
},
"type": "object"
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 9502,
"errorMessage": "[0401-9502]: Can not find promotion with ID = 111425 in project 59080"
}
}
}
}
}
}
}
},
"delete": {
"summary": "Удаление скидочной акции",
"tags": [
"promotions-discounts"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "delete-item-promotion",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"description": "Удаляет [скидочную акцию](https://developers.xsolla.com/ru/doc/shop-builder/features/discounts/). Удаленная акция:\n* Пропадет из списка акций, настроенных в вашем проекте.\n* Не будет применяться к каталогу товаров и к корзине. Пользователь не сможет купить товары с применением этой акции.\n\nПосле удаления акция не может быть восстановлена.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"responses": {
"204": {
"description": "Акция удалена успешно."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promotion"
}
}
}
},
"/v3/project/{project_id}/admin/promotion/bonus": {
"post": {
"summary": "Создание акции с бонусами",
"description": "Создает акцию с бонусами.\n\nАкция добавляет бесплатные бонусные товары к покупке, совершенной пользователем.\nАкция может быть применена к каждой покупке в рамках проекта или к покупке, включающей определенные товары.",
"operationId": "create-bonus-promotion",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"promotions-bonuses"
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_create-update-bonus-promotion"
},
"responses": {
"201": {
"$ref": "#/components/responses/Promotions_201-create-promotion"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-admin-promotion-missed-bonus-property"
}
}
},
"get": {
"tags": [
"promotions-bonuses"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "get-bonus-promotion-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"summary": "Получение списка акций с бонусами",
"description": "Получает список акций с бонусами в рамках проекта.\n\nАкция добавляет бесплатные бонусные товары к покупке, совершенной пользователем.\nАкция может быть применена к каждой покупке в рамках проекта или к покупке, включающей определенные товары.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-get-bonus-promotions"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
}
}
}
},
"/v3/project/{project_id}/admin/promotion/{promotion_id}/bonus": {
"put": {
"summary": "Обновление акции с бонусами",
"description": "Обновляет акцию.\n\nПримечание
Новые данные заменят старые. Если вы хотите обновить только часть акции, вам также следует передать в запросе все необходимые данные.
\n\nАкция добавляет бесплатные бонусные товары к покупке, совершенной пользователем.\nАкция может быть применена к каждой покупке в рамках проекта или к покупке, включающей определенные товары.",
"operationId": "update-bonus-promotion",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"tags": [
"promotions-bonuses"
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_create-update-bonus-promotion"
},
"responses": {
"204": {
"description": "Акция обновлена успешно."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-admin-promotion-missed-bonus-property"
}
}
},
"get": {
"tags": [
"promotions-bonuses"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "get-bonus-promotion",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"summary": "Получение акции с бонусами",
"description": "Получает акцию с бонусами.\n\nАкция добавляет бесплатные бонусные товары к покупке, совершенной пользователем.\nАкция может быть применена к каждой покупке в рамках проекта или к покупке, включающей определенные товары.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-admin-get-bonus-promotion"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promotion"
}
}
},
"delete": {
"summary": "Удаление бонусной акции",
"tags": [
"promotions-bonuses"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "delete-bonus-promotion",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"description": "Удаляет [бонусную акцию](https://developers.xsolla.com/ru/doc/shop-builder/features/bonuses/). Удаленная акция:\n* Пропадет из списка акций, настроенных в вашем проекте.\n* Не будет применяться к каталогу товаров и к корзине. Пользователь не сможет получить бонусные товары по этой акции.\n\nПосле удаления акция не может быть восстановлена.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"responses": {
"204": {
"description": "Акция удалена успешно."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promotion"
}
}
}
},
"/v2/project/{project_id}/promotion/code/{code}/verify": {
"get": {
"summary": "Подтвердите промокод",
"description": "Определяет, является ли код промокодом или купоном, и может ли пользователь его применить.
\n\n\n Примечание
\n Этот метод использует JWT пользователя для авторизации.
\n Передайте токен в заголовке Authorization в формате: Bearer <user_JWT>. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода.\n
",
"operationId": "verify-promotion-code",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"security": [
{
"XsollaLoginUserJWT": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/code-path-param"
}
],
"tags": [
"promotions-common"
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-verify-promo-code"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"403": {
"$ref": "#/components/responses/Promotions_403-auth-header"
},
"404": {
"$ref": "#/components/responses/Promotions_404-verify-promo-code"
},
"422": {
"$ref": "#/components/responses/Promotions_422-verify-promo-code"
}
}
}
},
"/v3/project/{project_id}/admin/unique_catalog_offer": {
"post": {
"operationId": "admin-create-unique-catalog-offer",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"summary": "Создание уникального предложения каталога",
"description": "Создает уникальное акционное предложение по каталогу.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"promotions-unique-catalog-offers"
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_unique_catalog_offer-create"
},
"responses": {
"201": {
"description": "Уникальное предложение по каталогу было успешно создано.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/Promotions_coupon-external_id"
}
}
},
"examples": {
"response": {
"value": {
"external_id": "coupon_external_id"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-invalid-coupon"
}
}
},
"get": {
"operationId": "get-unique-catalog-offers",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"promotions-unique-catalog-offers"
],
"security": [
{
"basicAuth": []
}
],
"summary": "Получение списка уникальных предложений каталога",
"description": "Получает список уникальных акционных предложений каталога проекта.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-get-unique-catalog-offers"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
}
}
}
},
"/v3/project/{project_id}/admin/unique_catalog_offer/{external_id}": {
"put": {
"operationId": "update-unique-catalog-offer-promotion",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"summary": "Обновление уникального предложения каталога",
"description": "Обновляет уникальное акционное предложение каталога.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"tags": [
"promotions-unique-catalog-offers"
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_unique_catalog_offer-update"
},
"responses": {
"204": {
"description": "Уникальное предложение каталога было успешно обновлено."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
},
"422": {
"$ref": "#/components/responses/Promotions_422-invalid-coupon"
}
}
},
"get": {
"operationId": "get-unique-catalog-offer",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"promotions-unique-catalog-offers"
],
"security": [
{
"basicAuth": []
}
],
"summary": "Получение уникального предложения каталога",
"description": "Получает указанное уникальное акционное предложение по каталогу.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"200": {
"description": "Уникальное предложение по каталогу было успешно получено.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Promotions_200-get-unique-catalog-offer-promotion-model"
},
"examples": {
"response": {
"value": {
"external_id": "secret_shop",
"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": "Secret shop",
"ru-RU": "Секретный магазин"
},
"items": [
"helmet",
"sword",
"shield"
],
"is_enabled": true,
"redeem_user_limit": 1,
"redeem_total_limit": 100,
"redeem_code_limit": 1,
"total_limit_state": {
"available": 50,
"reserved": 10,
"used": 40
}
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
}
}
},
"delete": {
"operationId": "delete-unique-catalog-offer-promotion",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"summary": "Удаление уникального предложения каталога",
"description": "Удаляет [уникальное акционное предложение каталога](https://developers.xsolla.com/ru/doc/shop-builder/features/unique-offer/). Удаленная акция:\n* Пропадет из списка акций, настроенных в вашем проекте.\n* Не будет применяться к каталогу товаров и к корзине. Пользователь не сможет купить товары с применением этой акции.\n\nПосле удаления акция не может быть восстановлена.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"tags": [
"promotions-unique-catalog-offers"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"204": {
"description": "Уникальное предложение каталога было успешно удалено."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
}
}
}
},
"/v2/project/{project_id}/admin/unique_catalog_offer/{external_id}/activate": {
"put": {
"operationId": "activate-unique-catalog-offer",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"summary": "Активация уникального предложения каталога",
"description": "Активирует уникальное предложение каталога. Созданная акция по умолчанию отключена. Пока акция не активирована, ее кодами нельзя воспользоваться. ",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"tags": [
"promotions-unique-catalog-offers"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"204": {
"description": "Уникальное предложение по каталогу было успешно активировано."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
},
"422": {
"$ref": "#/components/responses/Promotions_422-admin-promotion-error"
}
}
}
},
"/v2/project/{project_id}/admin/unique_catalog_offer/{external_id}/deactivate": {
"put": {
"operationId": "deactivate-unique-catalog-offer",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"summary": "Отключение уникального предложения каталога",
"description": "Отключает уникальное предложение каталога. После отключения акции ее кодами нельзя воспользоваться. Привязанные к акции скрытые товары не отображаются в каталоге.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"tags": [
"promotions-unique-catalog-offers"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"204": {
"description": "Уникальное предложение по каталогу было успешно деактивировано."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
},
"422": {
"$ref": "#/components/responses/Promotions_422-admin-promotion-error"
}
}
}
},
"/v2/project/{project_id}/admin/unique_catalog_offer/{external_id}/code": {
"post": {
"operationId": "create-unique-catalog-offer-code",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"summary": "Создание кода уникального предложения каталога",
"description": "Создает уникальный код предложения по каталогу.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"tags": [
"promotions-unique-catalog-offers"
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_create-coupon-promocode-code"
},
"responses": {
"201": {
"$ref": "#/components/responses/Promotions_201-coupon-promocode-code-created"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
},
"422": {
"$ref": "#/components/responses/Promotions_422-coupon-promocode-same-code-exists"
}
}
},
"get": {
"operationId": "get-unique-catalog-offer-codes",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"summary": "Получение списка кодов уникального предложения каталога",
"description": "Получает уникальные коды предложений по каталогу.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"promotions-unique-catalog-offers"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-unique-catalog-offer-code-list"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
}
}
}
},
"/v2/project/{project_id}/admin/unique_catalog_offer/{external_id}/code/generate": {
"put": {
"operationId": "generate-unique-catalog-offer-codes",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"summary": "Генерация кодов уникального предложения каталога",
"description": "Генерирует уникальные коды предложений по каталогу.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"tags": [
"promotions-unique-catalog-offers"
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"$ref": "#/components/schemas/Promotions_coupon-generate-count"
}
},
"required": [
"count"
]
}
}
}
},
"responses": {
"200": {
"description": "Коды успешно сгенерированы.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"$ref": "#/components/schemas/Promotions_coupon-generate-count"
}
}
},
"examples": {
"response": {
"value": {
"count": 10
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
}
}
}
},
"/v2/project/{project_id}/admin/user/limit/promocode/external_id/{external_id}": {
"get": {
"tags": [
"promotions-promo-codes"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "get-promo-code-user-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
},
{
"$ref": "#/components/parameters/user_external_id-query-param"
}
],
"summary": "Информация об ограничении на применение промокодов для указанного пользователя",
"description": "Получает информацию об оставшемся количестве применений промокода для указанного пользователя.\n\nAPI ограничений для пользователей позволяет ограничить доступное количество применений промокода. Для настройки самого ограничения перейдите в раздел администратора:\n* [Промокоды](https://developers.xsolla.com/ru/api/shop-builder/tag/promotions-promo-codes/)",
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-promo-code-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Товар не найден.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Promo code not found": {
"$ref": "#/components/examples/404-coupon-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
}
}
}
},
"422": {
"description": "Неверный запрос.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/Promotions_422-invalid-coupon"
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/user/limit/coupon/external_id/{external_id}": {
"get": {
"tags": [
"promotions-coupons"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "get-coupon-user-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
},
{
"$ref": "#/components/parameters/user_external_id-query-param"
}
],
"summary": "Информация об ограничении на применение купонов для указанного пользователя",
"description": "Получает информацию об оставшемся количестве применений купона для указанного пользователя.\n\nAPI ограничений для пользователей позволяет ограничить доступное количество применений купона. Для настройки самого ограничения перейдите в раздел администратора:\n* [Купоны](https://developers.xsolla.com/ru/api/shop-builder/tag/promotions-coupons/)",
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-coupon-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Товар не найден.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Coupon not found": {
"$ref": "#/components/examples/404-coupon-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
}
}
}
},
"422": {
"description": "Неверный запрос.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/Promotions_422-invalid-coupon"
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/code/limit/promocode/external_id/{external_id}": {
"get": {
"tags": [
"promotions-promo-codes"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "get-promo-code-code-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
},
{
"$ref": "#/components/parameters/codes-query-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"summary": "Информация об ограничении на применение промокодов",
"description": "Возвращает оставшееся количество применений кодов. Для фильтрации кодов используйте параметр запроса `codes`.\n\nДля настройки самого ограничения перейдите в раздел администратора:\n* [Промокоды](https://developers.xsolla.com/ru/api/shop-builder/tag/promotions-promo-codes/)",
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-code-promo-code-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Товар не найден.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Promo code not found": {
"$ref": "#/components/examples/404-coupon-not-found"
}
}
}
}
},
"422": {
"description": "Неверный запрос.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/code/limit/coupon/external_id/{external_id}": {
"get": {
"tags": [
"promotions-coupons"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "get-coupon-code-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
},
{
"$ref": "#/components/parameters/codes-query-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"summary": "Получение ограничений для уникальных кодов купонов",
"description": "Возвращает оставшееся количество применений кодов. Для фильтрации кодов используйте параметр запроса `codes`.\n\nДля настройки самого ограничения кода перейдите в раздел администратора:\n* [Купоны](https://developers.xsolla.com/ru/api/shop-builder/tag/promotions-coupons/)",
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-code-coupon-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Товар не найден.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Coupon not found": {
"$ref": "#/components/examples/404-coupon-not-found"
}
}
}
}
},
"422": {
"description": "Неверный запрос.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/user/attribute/rule": {
"get": {
"tags": [
"personalized-catalog"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "get-filter-rules",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/is_enabled-query-param"
}
],
"summary": "Получение списка правил фильтрации каталога",
"description": "Получает все правила, применяемые к атрибутам пользователя.",
"responses": {
"200": {
"description": "Правила получены успешно.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/user-attribute_personalized-catalog"
}
},
"total_items_count": {
"type": "number",
"description": "Total number of rules."
},
"has_more": {
"type": "boolean",
"description": "If another page with rules exists."
}
}
},
"examples": {
"response": {
"value": {
"items": [
{
"rule_id": 1,
"name": "Ork race armor rule",
"is_enabled": true,
"is_satisfied_for_unauth": false,
"attribute_conditions": [
{
"attribute": "race",
"operator": "eq",
"value": "ork",
"type": "string",
"can_be_missing": false
}
],
"items": [
{
"item_id": 1,
"sku": "com.xsolla.ork_armor_1",
"name": "Ork Armor",
"type": "virtual_good"
},
{
"item_id": 2,
"sku": "com.xsolla.potion_pack_1",
"name": "Potion pack",
"type": "bundle",
"bundle_type": "standard"
}
]
}
],
"total_items_count": 20,
"has_more": true
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
}
}
},
"post": {
"tags": [
"personalized-catalog"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "create-filter-rule",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"summary": "Создание правила фильтрации каталога",
"description": "Создает правило для пользовательских атрибутов.",
"responses": {
"201": {
"description": "Правило создано успешно.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"rule_id": {
"type": "number",
"description": "ID правила."
}
}
},
"examples": {
"response": {
"value": {
"rule_id": 1
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
},
"422": {
"$ref": "#/components/responses/Common_422-body-validation"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/personalized-catalog_create-update-body"
}
}
},
"/v2/project/{project_id}/admin/user/attribute/rule/all": {
"get": {
"tags": [
"personalized-catalog"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "get-all-filter-rules",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"summary": "Получение всех правил каталога для поиска на стороне клиента",
"description": "Возвращает список всех правил каталога для поиска на стороне клиента.\n\nВнимание
Возвращает только id правила, имя и is_enabled
",
"responses": {
"200": {
"description": "Правила получены успешно.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/user-attribute_personalized-catalog_all"
}
}
}
},
"examples": {
"response": {
"value": {
"items": [
{
"rule_id": 1,
"name": "Ork race armor rule",
"is_enabled": true,
"is_satisfied_for_unauth": false
},
{
"rule_id": 2,
"name": "Age",
"is_enabled": false,
"is_satisfied_for_unauth": false
}
]
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
}
}
}
},
"/v2/project/{project_id}/admin/user/attribute/rule/{rule_id}": {
"get": {
"tags": [
"personalized-catalog"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "get-filter-rule-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/personalized-catalog-rule_id-path-param"
}
],
"summary": "Получение правила фильтрации каталога",
"description": "Получает конкретное правило, применяемое к атрибутам пользователя.",
"responses": {
"200": {
"description": "Правило получено успешно.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user-attribute_personalized-catalog"
},
"examples": {
"response": {
"value": {
"rule_id": 1,
"name": "Ork race armor rule",
"is_enabled": true,
"is_satisfied_for_unauth": true,
"attribute_conditions": [
{
"attribute": "race",
"operator": "eq",
"value": "ork",
"type": "string",
"can_be_missing": false
}
],
"items": [
{
"item_id": 1,
"sku": "com.xsolla.ork_armor_1",
"name": "Ork Armor"
}
]
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
}
}
},
"put": {
"tags": [
"personalized-catalog"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "update-filter-rule-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/personalized-catalog-rule_id-path-param"
}
],
"summary": "Обновление правила фильтрации каталога",
"description": "Обновляет определенное правило, применяемое к атрибутам пользователя. Для неуказанных свойств (при их необязательности) будет использоваться значение по умолчанию.",
"responses": {
"204": {
"description": "Обновлено успешно."
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
},
"422": {
"$ref": "#/components/responses/Common_422-body-validation"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/personalized-catalog_create-update-body"
}
},
"patch": {
"tags": [
"personalized-catalog"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "patch-filter-rule-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/personalized-catalog-rule_id-path-param"
}
],
"summary": "Корректировка правила фильтрации каталога",
"description": "Обновляет определенное правило, применяемое к атрибутам пользователя. Для неуказанных свойств будет использоваться текущее значение.",
"responses": {
"204": {
"description": "Обновлено успешно."
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
},
"422": {
"$ref": "#/components/responses/Common_422-body-validation"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user-attribute_personalized-catalog-body"
},
"example": {
"is_enabled": false
}
}
}
}
},
"delete": {
"tags": [
"personalized-catalog"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "delete-filter-rule-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/personalized-catalog-rule_id-path-param"
}
],
"summary": "Удаление правила фильтрации каталога",
"description": "Удаляет определенное правило.",
"responses": {
"204": {
"description": "Удалено успешно."
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
}
}
}
},
"/v2/project/{project_id}/admin/user/limit/promotion/all": {
"delete": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "reset-all-user-promotions-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"summary": "Обновление лимитов акций для пользователя",
"description": "Обновляет все лимиты по всем акциям для указанного пользователя, чтобы он мог снова использовать эти акции.\n\nAPI лимитов пользователя позволяет ограничить количество раз, когда пользователи могут использовать рекламную акцию. Для настройки самого лимита перейдите в раздел Admin нужного типа акции:\n* [Акции со скидками](https://developers.xsolla.com/ru/api/shop-builder/tag/promotions-discounts/)\n* [Бонусные акции](https://developers.xsolla.com/ru/api/shop-builder/tag/promotions-bonuses/)",
"responses": {
"200": {
"description": "Лимит акции был успешно обновлен."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Товар не найден.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
}
}
}
},
"422": {
"description": "Неверный запрос.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/reset-user-limits"
}
}
},
"/v2/project/{project_id}/admin/user/limit/promotion/id/{promotion_id}/all": {
"delete": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "reset-user-promotion-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"summary": "Обновление лимита акций для пользователей",
"description": "Обновляет лимит акции, чтобы пользователь мог снова воспользоваться этой акцией. Если параметр *user* равен `null`, этот вызов обновляет это ограничение для всех пользователей.\n\nAPI лимитов пользователя позволяет ограничить количество раз, когда пользователи могут использовать рекламную акцию. Для настройки самого лимита перейдите в раздел Admin нужного типа акции:\n* [Акции со скидками](https://developers.xsolla.com/ru/api/shop-builder/tag/promotions-discounts/)\n* [Бонусные акции](https://developers.xsolla.com/ru/api/shop-builder/tag/promotions-bonuses/)",
"responses": {
"200": {
"description": "Лимит акции был успешно обновлен."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Товар не найден.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-promotion-by-id-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
}
}
}
},
"422": {
"description": "Неверный запрос.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Promotion does not have configured user limits": {
"$ref": "#/components/examples/422-promotion-without-user-limit"
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/reset-user-limits-flexible"
}
}
},
"/v2/project/{project_id}/admin/user/limit/promotion/id/{promotion_id}": {
"get": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "get-user-promotion-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
},
{
"$ref": "#/components/parameters/user_external_id-query-param"
}
],
"summary": "Получение лимита акций для пользователя",
"description": "Возвращает оставшееся количество раз, когда указанный пользователь может воспользоваться акцией в пределах установленного лимита.\n\nAPI лимитов пользователя позволяет ограничить количество раз, когда пользователи могут использовать рекламную акцию. Для настройки самого лимита перейдите в раздел Admin нужного типа акции:\n* [Акции со скидками](https://developers.xsolla.com/ru/api/shop-builder/tag/promotions-discounts/)\n* [Бонусные акции](https://developers.xsolla.com/ru/api/shop-builder/tag/promotions-bonuses/)",
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-promotion-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Товар не найден.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-promotion-by-id-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
}
}
}
},
"422": {
"description": "Неверный запрос.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Promotion does not have configured user limits": {
"$ref": "#/components/examples/422-promotion-without-user-limit"
}
}
}
}
}
}
},
"post": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "add-user-promotion-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"summary": "Увеличение лимита акций для пользователя",
"description": "Увеличивает оставшееся количество раз, когда указанный пользователь может воспользоваться акцией в пределах установленного лимита.\n\nAPI лимитов пользователя позволяет ограничить количество раз, когда пользователи могут использовать рекламную акцию. Для настройки самого лимита перейдите в раздел Admin нужного типа акции:\n* [Акции со скидками](https://developers.xsolla.com/ru/api/shop-builder/tag/promotions-discounts/)\n* [Бонусные акции](https://developers.xsolla.com/ru/api/shop-builder/tag/promotions-bonuses/)",
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-promotion-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Товар не найден.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-promotion-by-id-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
}
}
}
},
"422": {
"description": "Неверный запрос.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Promotion does not have configured user limits": {
"$ref": "#/components/examples/422-promotion-without-user-limit"
},
"Available promotion limit is out of range": {
"$ref": "#/components/examples/422-promotion-out-of-range-available-user-limit"
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/update-user-limits-strict"
}
},
"put": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "set-user-promotion-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"summary": "Настройка лимита акций для пользователя",
"description": "Задает количество раз, когда указанный пользователь может воспользоваться рекламной акцией в пределах лимита, примененного после его увеличения или уменьшения.\n\nAPI лимитов пользователя позволяет ограничить количество раз, когда пользователи могут использовать рекламную акцию. Для настройки самого лимита перейдите в раздел Admin нужного типа акции:\n* [Акции со скидками](https://developers.xsolla.com/ru/api/shop-builder/tag/promotions-discounts/)\n* [Бонусные акции](https://developers.xsolla.com/ru/api/shop-builder/tag/promotions-bonuses/)",
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-promotion-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Товар не найден.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-promotion-by-id-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
}
}
}
},
"422": {
"description": "Неверный запрос.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Promotion does not have configured user limits": {
"$ref": "#/components/examples/422-promotion-without-user-limit"
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/update-user-limits-flexible"
}
},
"delete": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "remove-user-promotion-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"summary": "Уменьшение лимита акций для пользователя",
"description": "Уменьшает оставшееся количество раз, когда указанный пользователь может воспользоваться акцией в пределах установленного лимита.\n\nAPI лимитов пользователя позволяет ограничить количество раз, когда пользователи могут использовать рекламную акцию. Для настройки самого лимита перейдите в раздел Admin нужного типа акции:\n* [Акции со скидками](https://developers.xsolla.com/ru/api/shop-builder/tag/promotions-discounts/)\n* [Бонусные акции](https://developers.xsolla.com/ru/api/shop-builder/tag/promotions-bonuses/)",
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-promotion-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Товар не найден.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-promotion-by-id-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
}
}
}
},
"422": {
"description": "Неверный запрос.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Promotion does not have configured user limits": {
"$ref": "#/components/examples/422-promotion-without-user-limit"
},
"Available promotion limit is out of range": {
"$ref": "#/components/examples/422-promotion-out-of-range-available-user-limit"
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/update-user-limits-strict"
}
}
},
"/v2/project/{project_id}/admin/items/value_points": {
"get": {
"summary": "Получение списка призовых баллов",
"description": "Получает список призовых баллов для проекта администрирования.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"reward-chain-value-points-admin"
],
"operationId": "admin-get-value-points-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-value-points"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
}
},
"post": {
"summary": "Создание призовых баллов",
"description": "Создает призовые баллы, которые выдаются за покупку товаров в каталоге.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"reward-chain-value-points-admin"
],
"operationId": "admin-create-value-points",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-value-point"
},
"responses": {
"201": {
"$ref": "#/components/responses/201-admin-create-value-point"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/422-admin-create-update-rc-vp-invalid-request"
}
}
}
},
"/v2/project/{project_id}/admin/items/value_points/sku/{item_sku}": {
"get": {
"summary": "Получение призовых баллов",
"description": "Получает призовые баллы по артикулу для проекта администрирования.",
"operationId": "admin-get-value-point",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"reward-chain-value-points-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-value-point"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
}
},
"put": {
"summary": "Обновление призовых баллов",
"description": "Обновляет призовые баллы, идентифицированные по артикулу.",
"operationId": "admin-update-value-point",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"reward-chain-value-points-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/create-value-point"
},
"responses": {
"204": {
"description": "Призовый балл был успешно обновлен.",
"content": {}
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/422-admin-create-update-rc-vp-invalid-request"
}
}
},
"delete": {
"summary": "Удаление призовых баллов",
"description": "Удаляет призовые баллы, идентифицированные по артикулу товара.",
"operationId": "admin-delete-value-point",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"reward-chain-value-points-admin"
],
"responses": {
"204": {
"description": "Призовый балл был успешно удален.",
"content": {}
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/{value_point_sku}/value_points/rewards": {
"get": {
"summary": "Получение списка товаров с призовыми баллами",
"description": "Получает список всех товаров с призовыми баллами для проекта администрирования.",
"operationId": "admin-get-items-value-point-reward",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/value_point_sku-path-param"
}
],
"tags": [
"reward-chain-value-points-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-list-value-point-rewards"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
}
},
"put": {
"summary": "Настройка призовых баллов для товаров",
"description": "Присваивает призовые баллы одному или нескольким товарам по артикулу. Пользователи получают призовые баллы после покупки этих товаров.\n\nОбратите внимание, что этот запрос PUT перезаписывает все ранее установленные призовые баллы для товаров в проекте.\n\nЧтобы избежать непреднамеренного удаления призовых баллов, включайте все товары и соответствующие им значения в каждый запрос PUT.\n\nЕсли вы хотите обновить призовые баллы только для определенного товара, сохранив значения призовых баллов для других товаров, вам следует получить текущий набор призовых баллов с помощью запроса GET, изменить значения призовых баллов для желаемого товара, а затем отправить измененный набор призовых баллов обратно с обновленными значениями призовых баллов для конкретного товара.",
"operationId": "admin-set-items-value-point-reward",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/value_point_sku-path-param"
}
],
"tags": [
"reward-chain-value-points-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/set-item-value-point-reward"
},
"responses": {
"204": {
"description": "Призовые баллы для товаров были успешно обновлены.",
"content": {}
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/sellable-item-by-sku_404"
}
}
},
"patch": {
"summary": "Частичное обновление призовых баллов для товаров ",
"description": "Частично обновляет количество призовых баллов для одного или нескольких товаров по артикулам этих товаров. Пользователи получают призовые баллы после покупки этих товаров.\n\nПринципы обновления призовых баллов:\n * Если у товара еще нет призовых баллов, отправка ненулевого значения в поле `amount` создаст их.\n * Если у товара уже есть призовые баллы, отправка ненулевого значения в поле `amount` обновит их.\n * Если в поле `amount` передано значение 0, существующие призовые баллы для этого товара будут удалены.\n\nВ отличие от метода `PUT` ([Настройка призовых баллов для товаров](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-set-items-value-point-reward/)), этот метод `PATCH` не перезаписывает все ранее установленные призовые баллы для товаров в проекте, а обновляет только указанные.\n\nВ одном запросе можно обновить до 100 товаров. В одном запросе нельзя передавать одинаковые артикулы товаров.",
"operationId": "admin-patch-items-value-point-reward",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/value_point_sku-path-param"
}
],
"tags": [
"reward-chain-value-points-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/set-item-value-point-reward-for-patch"
},
"responses": {
"204": {
"description": "Призовые баллы для товаров были успешно обновлены.",
"content": {}
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/sellable-item-by-sku_404"
}
}
},
"delete": {
"summary": "Удаление призовых баллов с товаров",
"description": "Удаляет призовые баллы со ВСЕХ товаров.",
"operationId": "admin-delete-items-value-point-reward",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/value_point_sku-path-param"
}
],
"tags": [
"reward-chain-value-points-admin"
],
"responses": {
"204": {
"description": "Призовые баллы для товаров были успешно удалены.",
"content": {}
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/user/reward_chain": {
"get": {
"tags": [
"reward-chain-client"
],
"operationId": "get-reward-chains-list",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"summary": "Получение цепочки наград текущего пользователя",
"description": "Метод клиента. Получает цепочки наград текущего пользователя.\n\n\nВнимание
\nВсе проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset.\n
\n\n
\n\n\n Примечание
\n Этот метод использует JWT пользователя для авторизации.
\n Передайте токен в заголовке Authorization в формате: Bearer <user_JWT>. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода.\n
",
"security": [
{
"XsollaLoginUserJWT": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-client-get-reward-chains-list"
}
}
}
},
"/v2/project/{project_id}/user/reward_chain/{reward_chain_id}/balance": {
"get": {
"tags": [
"reward-chain-client"
],
"operationId": "get-user-reward-chain-balance",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"summary": "Получение призовых баллов текущего пользователя",
"description": "Метод клиента. Возвращает призовые баллы текущего пользователя.
\n\n\n Примечание
\n Этот метод использует JWT пользователя для авторизации.
\n Передайте токен в заголовке Authorization в формате: Bearer <user_JWT>. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода.\n
",
"security": [
{
"XsollaLoginUserJWT": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/reward_chain_id-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-client-get-user-reward-chain-balance"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
}
}
}
},
"/v2/project/{project_id}/user/reward_chain/{reward_chain_id}/step/{step_id}/claim": {
"post": {
"tags": [
"reward-chain-client"
],
"operationId": "claim-user-reward-chain-step-reward",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"summary": "Получение награды на уровне",
"description": "Метод клиента. Запрашивает награду на уровне для текущего пользователя в цепочке наград.
\n\n\n Примечание
\n Этот метод использует JWT пользователя для авторизации.
\n Передайте токен в заголовке Authorization в формате: Bearer <user_JWT>. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода.\n
",
"security": [
{
"XsollaLoginUserJWT": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/reward_chain_id-path-param"
},
{
"$ref": "#/components/parameters/reward_chain_step_id-path-param"
}
],
"responses": {
"204": {
"description": "Успешно получена награда за уровнь для текущего пользователя в цепочке наград."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"404": {
"$ref": "#/components/responses/404-reward-chain-step-not-found"
},
"422": {
"$ref": "#/components/responses/422-reward-chain-step-reward-can-not-claimed"
}
}
}
},
"/v2/project/{project_id}/user/clan/contributors/{reward_chain_id}/top": {
"get": {
"tags": [
"clan-reward-chain-client"
],
"operationId": "get-user-clan-top-contributors",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"responses": {
"200": {
"description": "10 участников, внесших наибольший вклад в цепочку наград клана.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Rocket",
"description": "User ID. This is the ID sending to Xsolla during authorization and links the user to your Xsolla Login project."
},
"contributed_amount": {
"type": "integer",
"example": 100,
"description": "The amount of value points contributed by the user."
}
}
}
},
"examples": {
"clan": {
"summary": "User has a clan",
"value": [
{
"name": "winner",
"contributed_amount": 555
},
{
"name": "Rocket",
"contributed_amount": 398
},
{
"name": "MrJoe",
"contributed_amount": 201
},
{
"name": "beginner",
"contributed_amount": 1
}
]
},
"without-clan": {
"summary": "User doesn't belong to a clan",
"value": []
}
}
}
}
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"description": "ID проекта.",
"schema": {
"type": "integer",
"example": 44056
}
},
{
"name": "reward_chain_id",
"in": "path",
"required": true,
"description": "ID цепочки наград.",
"schema": {
"type": "integer",
"example": 101
}
}
],
"summary": "Получение 10 участников, внесших наибольший вклад в продвижение по клановой цепочке наград",
"description": "Возвращает 10 участников, внесших наибольший вклад в определенную цепочку наград для текущего клана пользователя. Если пользователь не состоит в клане, в ответе вернется пустой массив.
\n\n\n Примечание
\n Этот метод использует JWT пользователя для авторизации.
\n Передайте токен в заголовке Authorization в формате: Bearer <user_JWT>. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода.\n
"
}
},
"/v2/project/{project_id}/user/clan/update": {
"put": {
"tags": [
"clan-reward-chain-client"
],
"operationId": "user-clan-update",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-client-update-user-clan"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"description": "ID проекта.",
"schema": {
"type": "integer",
"default": 44056
}
}
],
"summary": "Обновление клана текущего пользователя",
"description": "Обновляет текущий клан пользователя через атрибуты пользователя. Выдает пользователю награды, которые он не забрал из цепочки наград старого клана, и возвращает их в ответе. Если пользователь состоял в клане, а теперь нет — принадлежность к клану будет удалена. Если пользователь сменил клан, принадлежность к клану изменится и будет указан новый клан.
\n\n\n Примечание
\n Этот метод использует JWT пользователя для авторизации.
\n Передайте токен в заголовке Authorization в формате: Bearer <user_JWT>. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода.\n
"
}
},
"/v3/project/{project_id}/admin/reward_chain": {
"get": {
"summary": "Получение списка цепочек наград",
"description": "Получает список цепочек наград.\n\nВнимание!
Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 10 товаров в ответе.Чтобы получить больше данных постранично, используйте поля limit и offset.
",
"operationId": "admin-get-reward-chains",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/enabled-query-param"
}
],
"tags": [
"reward-chain-value-points-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-list-reward-chains"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
}
},
"post": {
"summary": "Создание цепочек наград",
"description": "Создает цепочку наград.",
"security": [
{
"basicAuth": []
}
],
"operationId": "admin-create-reward-chain",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"reward-chain-value-points-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/create-reward-chain"
},
"responses": {
"201": {
"$ref": "#/components/responses/201-admin-create-reward-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/422-admin-create-update-rc-vp-invalid-request"
}
}
}
},
"/v3/project/{project_id}/admin/reward_chain/id/{reward_chain_id}": {
"get": {
"summary": "Получение цепочек наград",
"description": "Получает определенную цепочку наград.",
"operationId": "admin-get-reward-chain",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/reward_chain_id-path-param"
}
],
"tags": [
"reward-chain-value-points-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-reward-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-admin-reward-chain-not-found"
}
}
},
"put": {
"summary": "Обновление цепочек наград",
"description": "Обновляет определенную цепочку наград.",
"security": [
{
"basicAuth": []
}
],
"operationId": "admin-update-reward-chain",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/reward_chain_id-path-param"
}
],
"tags": [
"reward-chain-value-points-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/update-reward-chain"
},
"responses": {
"204": {
"$ref": "#/components/responses/204-admin-update-reward-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-admin-reward-chain-not-found"
},
"422": {
"$ref": "#/components/responses/422-admin-create-update-rc-vp-invalid-request"
}
}
},
"delete": {
"summary": "Удаление цепочек наград",
"description": "Удаляет определенную цепочку наград.",
"security": [
{
"basicAuth": []
}
],
"operationId": "admin-delete-reward-chain",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/reward_chain_id-path-param"
}
],
"tags": [
"reward-chain-value-points-admin"
],
"responses": {
"204": {
"$ref": "#/components/responses/204-admin-delete-reward-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
}
}
},
"/v3/project/{project_id}/admin/reward_chain/id/{reward_chain_id}/toggle": {
"put": {
"summary": "Переключение цепочки наград",
"description": "Включение/отключение цепочки наград.",
"security": [
{
"basicAuth": []
}
],
"operationId": "admin-toggle-reward-chain",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/reward_chain_id-path-param"
}
],
"tags": [
"reward-chain-value-points-admin"
],
"responses": {
"204": {
"$ref": "#/components/responses/204-admin-toggle-reward-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
}
}
},
"/v3/project/{project_id}/admin/reward_chain/id/{reward_chain_id}/reset": {
"post": {
"summary": "Сброс цепочки наград",
"description": "Сбрасывает баланс призовых баллов и прогресс всех пользователей в цепочке наград.
Баланс привязан к типу баллов, а не к цепочке. Если эти баллы используются в других цепочках, баланс будет сброшен во всех цепочках с этими баллами.
После выполнения сброса вы можете обновить срок действия цепочки наград, и пользователи смогут снова продвигаться по ней.
Баланс клана рассчитывается как сумма балансов его участников, поэтому после выполнения сброса баланс клана также будет обнулен.
Этот запрос необратим и применяется ко всем пользователям проекта.\n\nВнимание\n
\nНе следует сбрасывать цепочку наград в период ее действия. В этом случае пользователи могут потерять заработанные очки до получения награды.\n
",
"security": [
{
"basicAuth": []
}
],
"operationId": "admin-reset-reward-chain",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/reward_chain_id-path-param"
}
],
"tags": [
"reward-chain-value-points-admin"
],
"responses": {
"204": {
"$ref": "#/components/responses/204-admin-reset-reward-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/daily_chain": {
"get": {
"summary": "Получение списка ежедневных наград",
"description": "Возвращает список ежедневных наград для администрирования.\n\nПримечание
Метод возвращает список элементов с учетом пагинации. Максимальное количество элементов в ответе — 50 (установлено по умолчанию). Чтобы получить доступ к следующим элементам списка, используйте параметры `limit` и `offset`. Например, при вызове метода с параметрами `limit = 25` и `offset = 100` вернется 25 элементов, начиная со 101-го в общем списке.
",
"operationId": "admin-get-daily-chains",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/enabled-query-param"
},
{
"$ref": "#/components/parameters/is_expired-daily-chain-query-param"
},
{
"$ref": "#/components/parameters/type-daily-chain-query-param"
}
],
"tags": [
"daily-chain-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-list-daily-chains"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
}
},
"post": {
"summary": "Создание ежедневной награды",
"description": "Создает ежедневную награду.",
"security": [
{
"basicAuth": []
}
],
"operationId": "admin-create-daily-chain",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"daily-chain-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/create-daily-chain"
},
"responses": {
"201": {
"$ref": "#/components/responses/201-admin-create-daily-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/422-admin-create-error-list"
}
}
}
},
"/v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}": {
"get": {
"summary": "Получение ежедневной награды",
"description": "Возвращает определенную ежедневную награду для администрирования.",
"operationId": "admin-get-daily-chain",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/daily_chain_id-path-param"
}
],
"tags": [
"daily-chain-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-daily-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-daily-chain-not-found"
}
}
},
"put": {
"summary": "Обновление ежедневной награды",
"description": "Обновляет определенную ежедневную награду.",
"security": [
{
"basicAuth": []
}
],
"operationId": "admin-update-daily-chain",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/daily_chain_id-path-param"
}
],
"tags": [
"daily-chain-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/update-daily-chain"
},
"responses": {
"204": {
"description": "Ежедневная награда успешно обновлена.",
"content": {}
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-daily-chain-not-found"
},
"422": {
"$ref": "#/components/responses/422-admin-update-error-list"
}
}
},
"delete": {
"summary": "Удаление ежедневной награды",
"description": "Удаляет определенную ежедневную награду.",
"security": [
{
"basicAuth": []
}
],
"operationId": "admin-delete-daily-chain",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/daily_chain_id-path-param"
}
],
"tags": [
"daily-chain-admin"
],
"responses": {
"204": {
"description": "Ежедневная награда успешно удалена.",
"content": {}
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-daily-chain-not-found"
}
}
}
},
"/v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}/toggle": {
"put": {
"summary": "Переключение ежедневной награды",
"description": "Включает или отключает ежедневную награду.",
"security": [
{
"basicAuth": []
}
],
"operationId": "admin-toggle-daily-chain",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/daily_chain_id-path-param"
}
],
"tags": [
"daily-chain-admin"
],
"responses": {
"204": {
"description": "Ежедневная награда отключена или включена.",
"content": {}
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-daily-chain-not-found"
}
}
}
},
"/v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}/reset": {
"post": {
"summary": "Сброс ежедневной награды",
"description": "Сбрасывает прогресс для всех пользователей в ежедневной награде. Применяется только к ежедневным наградам с типом `rolling`.",
"security": [
{
"basicAuth": []
}
],
"operationId": "admin-reset-daily-chain",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/daily_chain_id-path-param"
}
],
"tags": [
"daily-chain-admin"
],
"responses": {
"204": {
"description": "Ежедневная награда сброшена.",
"content": {}
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-daily-chain-not-found"
}
}
}
},
"/v2/project/{project_id}/user/daily_chain": {
"get": {
"tags": [
"daily-chain-client"
],
"operationId": "get-daily-chains-list",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"summary": "Получение ежедневных наград для текущего пользователя",
"description": "Метод клиента. Получает ежедневные награды текущего пользователя.\n\nПримечание
Метод возвращает список элементов с учетом пагинации. Максимальное количество элементов в ответе — 50 (установлено по умолчанию). Чтобы получить доступ к следующим элементам списка, используйте параметры limit и offset. Например, при вызове метода с параметрами limit = 25 и offset = 100 вернется 25 элементов, начиная со 101-го в общем списке.
\n\n
\n\n\n Примечание
\n Этот метод использует JWT пользователя для авторизации.
\n Передайте токен в заголовке Authorization в формате: Bearer <user_JWT>. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода.\n
",
"security": [
{
"XsollaLoginUserJWT": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-client-get-daily-chains-list"
},
"401": {
"$ref": "#/components/responses/401-client-auth-error"
}
}
}
},
"/v2/project/{project_id}/user/daily_chain/{daily_chain_id}": {
"get": {
"tags": [
"daily-chain-client"
],
"operationId": "get-user-daily-chain-by-id",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"summary": "Получение ежедневной награды по ее ID для текущего пользователя",
"description": "Метод клиента. Возвращает ежедневную награду по ее ID для текущего пользователя.
\n\n\n Примечание
\n Этот метод использует JWT пользователя для авторизации.
\n Передайте токен в заголовке Authorization в формате: Bearer <user_JWT>. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода.\n
",
"security": [
{
"XsollaLoginUserJWT": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/daily_chain_id-path-param"
}
],
"responses": {
"200": {
"description": "Ежедневная награда пользователя успешно получена.",
"content": {
"application/json": {
"examples": {
"response": {
"$ref": "#/components/examples/200-client-daily-chain"
}
},
"schema": {
"$ref": "#/components/schemas/client-daily-chain-model"
}
}
}
},
"404": {
"$ref": "#/components/responses/404-daily-chain-not-found"
}
}
}
},
"/v2/project/{project_id}/user/daily_chain/{daily_chain_id}/step/number/{step_number}/claim": {
"post": {
"tags": [
"daily-chain-client"
],
"operationId": "claim-user-daily-chain-step-reward",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"summary": "Получение ежедневной награды за уровень",
"description": "Метод клиента. Возвращает награду на текущем уровне в цепочке ежедневных наград для текущего пользователя. Все уровни могут быть пройдены только в заданном порядке. Награду за пропущенный уровень нельзя получить за виртуальную или реальную валюту, или просмотр рекламного ролика.
\n\n\n Примечание
\n Этот метод использует JWT пользователя для авторизации.
\n Передайте токен в заголовке Authorization в формате: Bearer <user_JWT>. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода.\n
",
"security": [
{
"XsollaLoginUserJWT": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/daily_chain_id-path-param"
},
{
"$ref": "#/components/parameters/daily_chain_step_number-path-param"
}
],
"responses": {
"204": {
"description": "Успешно получена награда за уровнь для текущего пользователя в цепочке ежедневных наград."
},
"401": {
"$ref": "#/components/responses/401-client-auth-error"
},
"404": {
"$ref": "#/components/responses/404-daily-chain-step-not-found"
},
"422": {
"description": "Награда за уровень не может быть получена.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/daily-chain-error-model"
},
"examples": {
"invalid-step": {
"$ref": "#/components/examples/422-daily-chain-claim-error-invalid-step"
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/user/offer_chain": {
"get": {
"tags": [
"offer-chain-client"
],
"operationId": "get-offer-chains-list",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"summary": "Получение цепочек предложений для текущего пользователя",
"description": "Возвращает цепочки предложений для текущего пользователя.\n\nВнимание
Все проекты имеют ограничение на количество элементов, возвращаемых в одном ответе. Максимальное значение — 30 элементов на запрос. Чтобы получить больше данных, используйте параметры limit и offset для пагинации.
\n\n
\n\n\n Примечание
\n Этот метод использует JWT пользователя для авторизации.
\n Передайте токен в заголовке Authorization в формате: Bearer <user_JWT>. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода.\n
",
"security": [
{
"XsollaLoginUserJWT": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-client-get-offer-chains-list"
}
}
}
},
"/v2/project/{project_id}/user/offer_chain/{offer_chain_id}": {
"get": {
"tags": [
"offer-chain-client"
],
"operationId": "get-user-offer-chain-by-id",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"summary": "Получение цепочки предложений по ее ID для текущего пользователя",
"description": "Возвращает цепочку предложений по ее ID для текущего пользователя.
\n\n\n Примечание
\n Этот метод использует JWT пользователя для авторизации.
\n Передайте токен в заголовке Authorization в формате: Bearer <user_JWT>. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода.\n
",
"security": [
{
"XsollaLoginUserJWT": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/offer_chain_id-path-param"
}
],
"responses": {
"200": {
"description": "Цепочка предложений пользователя успешно восстановлена.",
"content": {
"application/json": {
"examples": {
"response": {
"$ref": "#/components/examples/200-client-offer-chain"
}
},
"schema": {
"$ref": "#/components/schemas/client-offer-chain-model"
}
}
}
},
"404": {
"$ref": "#/components/responses/404-offer-chain-not-found"
}
}
}
},
"/v2/project/{project_id}/user/offer_chain/{offer_chain_id}/step/number/{step_number}/claim": {
"post": {
"tags": [
"offer-chain-client"
],
"operationId": "claim-user-offer-chain-step-reward",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"summary": "Получение награды за уровень цепочки предложений",
"description": "Завершает прохождение текущим пользователем уровня цепочки предложений и выдает связанную с ним награду.\n\n\n\n
\n\n\n Примечание
\n Этот метод использует JWT пользователя для авторизации.
\n Передайте токен в заголовке Authorization в формате: Bearer <user_JWT>. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода.\n
",
"security": [
{
"XsollaLoginUserJWT": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/offer_chain_id-path-param"
},
{
"$ref": "#/components/parameters/offer_chain_step_number-path-param"
}
],
"responses": {
"200": {
"description": "Награда на бесплатном шаге для текущего пользователя успешно получена.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"description": "ID заказа."
}
}
},
"examples": {
"response": {
"value": {
"order_id": 641
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"404": {
"$ref": "#/components/responses/404-offer-chain-step-not-found"
},
"422": {
"description": "Невозможно получить награду на шаге. Убедитесь, что все предыдущие шаги пройдены и текущий шаг бесплатный.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/offer-chain-error-model"
},
"examples": {
"invalid-step": {
"$ref": "#/components/examples/422-offer-chain-claim-error-invalid-step"
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/user/offer_chain/{offer_chain_id}/step/number/{step_number}/order": {
"post": {
"tags": [
"offer-chain-client",
"payment-client-side"
],
"operationId": "order-user-offer-chain-step-reward",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"summary": "Создание заказа на награду за уровень цепочки предложений",
"description": "Создает заказ на товар, связанный с указанным уровнем цепочки предложений. Полученный заказ получает статус `new`.\n\nЧтобы открыть платежный интерфейс в новом окне, воспользуйтесь следующей ссылкой: `https://secure.xsolla.com/paystation4/?token={token}`, где `{token}` — полученный токен.\n\nДля целей тестирования используйте этот URL-адрес: `https://sandbox-secure.xsolla.com/paystation4/?token={token}`.\n\n\n
Внимание \nИспользуйте этот метод только на стороне клиента. Метод определяет страну пользователя по IP-адресу, чтобы применить соответствующую валюту и доступные способы оплаты. Вызов с сервера может привести к некорректному определению валюты и повлиять на способы оплаты в
Pay Station.\n
\n\n\n\n
\n\n\n Примечание
\n Этот метод использует JWT пользователя для авторизации.
\n Передайте токен в заголовке Authorization в формате: Bearer <user_JWT>. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода.\n
",
"security": [
{
"XsollaLoginUserJWT": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/offer_chain_id-path-param"
},
{
"$ref": "#/components/parameters/offer_chain_step_number-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Payment_200-order-created"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"404": {
"$ref": "#/components/responses/404-offer-chain-step-not-found"
},
"422": {
"description": "Покупка шага невозможна.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/offer-chain-error-model"
},
"examples": {
"invalid-step": {
"$ref": "#/components/examples/422-offer-chain-claim-error-invalid-step"
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/offer_chain": {
"get": {
"summary": "Получение списка цепочек предложений",
"description": "Возвращает список цепочек предложений для администрирования.\n\nВнимание
Все проекты имеют ограничение на количество элементов, возвращаемых в одном ответе. Максимальное значение — 10 элементов в ответе. Чтобы получить больше данных, используйте query-параметры limit и offset для пагинации.
",
"operationId": "admin-get-offer-chains",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/enabled-query-param"
}
],
"tags": [
"offer-chain-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-list-offer-chains"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
}
},
"post": {
"summary": "Создание цепочки предложений",
"description": "Создает цепочку предложений.",
"security": [
{
"basicAuth": []
}
],
"operationId": "admin-create-offer-chain",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"offer-chain-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/create-offer-chain"
},
"responses": {
"201": {
"$ref": "#/components/responses/201-admin-create-offer-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/422-create-error-list"
}
}
}
},
"/v2/project/{project_id}/admin/offer_chain/id/{offer_chain_id}": {
"get": {
"summary": "Получение цепочки предложений",
"description": "Возвращает конкретную цепочку предложений для администрирования.",
"operationId": "admin-get-offer-chain",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/offer_chain_id-path-param"
}
],
"tags": [
"offer-chain-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-offer-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-offer-chain-not-found"
}
}
},
"put": {
"summary": "Обновление цепочки предложений",
"description": "Обновляет конкретную цепочку предложений.",
"security": [
{
"basicAuth": []
}
],
"operationId": "admin-update-offer-chain",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/offer_chain_id-path-param"
}
],
"tags": [
"offer-chain-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/update-offer-chain"
},
"responses": {
"204": {
"description": "Цепочка предложений была успешно обновлена.",
"content": {}
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-offer-chain-not-found"
},
"422": {
"$ref": "#/components/responses/422-update-error-list"
}
}
},
"delete": {
"summary": "Удаление цепочки предложений",
"description": "Удаляет конкретную цепочку предложений.\n\nПосле удаления цепочки:- Все уже полученные пользователями награды сохраняются.
- Непройденные уровни становятся недоступны, и получить награды за них больше нельзя.
\n\nУдаление цепочки необратимо и не сохраняет прогресс пользователя, в отличие от временного отключения цепочки с помощью метода Переключение цепочки предложений.",
"security": [
{
"basicAuth": []
}
],
"operationId": "admin-delete-offer-chain",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/offer_chain_id-path-param"
}
],
"tags": [
"offer-chain-admin"
],
"responses": {
"204": {
"description": "Цепочка предложений успешно удалена.",
"content": {}
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-offer-chain-not-found"
}
}
}
},
"/v2/project/{project_id}/admin/offer_chain/id/{offer_chain_id}/toggle": {
"put": {
"summary": "Переключение цепочки предложений",
"description": "Включает или отключает цепочку предложений.\n\nПри отключении цепочки пользователи теряют доступ к ней, но их прогресс сохраняется.\n\nПосле повторного включения цепочки пользователь может продолжить прохождение с того уровня, на котором остановился.",
"security": [
{
"basicAuth": []
}
],
"operationId": "admin-toggle-offer-chain",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/offer_chain_id-path-param"
}
],
"tags": [
"offer-chain-admin"
],
"responses": {
"204": {
"description": "Цепочка предложений отключена/включена.",
"content": {}
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-offer-chain-not-found"
}
}
}
},
"/v2/project/{project_id}/admin/items/upsell": {
"get": {
"tags": [
"upsell-admin"
],
"operationId": "get-upsell-configurations-for-project-admin",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"responses": {
"200": {
"description": "Список деталей настройки и товаров, которые используются для апселла в проекте.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"is_enabled": {
"type": "boolean",
"example": true,
"description": "Whether upsell is enabled for the project."
},
"type": {
"type": "string",
"enum": [
"fixed_list",
"most_sellable",
"only_promotions"
],
"example": "fixed_list",
"description": "The type of upsell."
},
"items": {
"type": "array",
"example": [
{
"item_id": 1,
"sku": "com.xsolla.booster_mega_1",
"name": {
"en": "Item's name",
"de": "Name des Artikels"
},
"type": "virtual_good"
}
],
"description": "The list of items SKU that are a part of the upsell in the project.",
"items": {
"type": "object",
"properties": {
"item_id": {
"$ref": "#/components/schemas/item_id"
},
"sku": {
"$ref": "#/components/schemas/sku"
},
"type": {
"$ref": "#/components/schemas/item_type"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"bundle_type": {
"$ref": "#/components/schemas/bundle_type"
},
"unit_type": {
"$ref": "#/components/schemas/unit_type"
},
"unit_items": {
"type": "array",
"description": "Game keys for different DRMs.",
"items": {
"type": "object",
"description": "Game key item. It represents game on a certain platform (steam, gog, etc.).",
"properties": {
"item_id": {
"$ref": "#/components/schemas/item_id"
},
"sku": {
"$ref": "#/components/schemas/sku"
},
"type": {
"$ref": "#/components/schemas/item_type"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"drm_name": {
"$ref": "#/components/schemas/drm_name"
},
"drm_sku": {
"$ref": "#/components/schemas/drm_sku"
}
}
}
}
}
}
}
}
}
},
"examples": {
"upsell": {
"summary": "Project has upsell",
"value": [
{
"is_enabled": true,
"type": "fixed_list",
"items": [
{
"item_id": 1,
"sku": "com.xsolla.booster_mega_1",
"name": {
"en": "Item's name",
"de": "Name des Artikels"
},
"type": "virtual_good"
},
{
"item_id": 2,
"sku": "com.xsolla.booster_mega_2",
"name": {
"en": "Item's name",
"de": "Name des Artikels"
},
"type": "bundle",
"bundle_type": "standard"
},
{
"item_id": 3,
"sku": "com.xsolla.mega_game_1",
"name": {
"en": "Mega game"
},
"type": "unit",
"unit_type": "game",
"unit_items": [
{
"item_id": 4,
"sku": "com.xsolla.mega_game_steam_1",
"name": {
"en": "Mega game steam"
},
"drm_name": "Steam",
"drm_sku": "steam_key_1"
}
]
}
]
}
]
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"summary": "Получение информации об апселле в проекте",
"description": "Возвращает информацию об апселле в проекте: включен или выключен апселл, какой тип апселла используется, а также список товаров, используемых в апселле."
},
"post": {
"tags": [
"upsell-admin"
],
"operationId": "post-upsell",
"summary": "Создание апселла",
"description": "Создает апселл в проекте.
\n\n\n Уведомление
\n Этот метод использует JWT пользователя для авторизации.
\n Передайте токен в заголовке Authorization в формате Bearer <user_JWT>. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода.\n
",
"security": [
{
"XsollaLoginUserJWT": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-upsell"
},
"responses": {
"202": {
"description": "Апселл создан в проекте."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"404": {
"$ref": "#/components/responses/Upsell-404-item-not-found"
},
"422": {
"$ref": "#/components/responses/Upsell-422-invalid-request"
}
}
},
"put": {
"tags": [
"upsell-admin"
],
"operationId": "put-upsell",
"summary": "Обновление апселла",
"description": "Обновляет апселл в проекте.
\n\n\n Уведомление
\n Этот метод использует JWT пользователя для авторизации.
\n Передайте токен в заголовке Authorization в формате Bearer <user_JWT>. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода.\n
",
"security": [
{
"XsollaLoginUserJWT": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/update-upsell"
},
"responses": {
"202": {
"description": "Апселл обновлен в проекте."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"404": {
"$ref": "#/components/responses/Upsell-404-item-not-found"
},
"422": {
"$ref": "#/components/responses/Upsell-422-invalid-request"
}
}
}
},
"/v2/project/{project_id}/admin/items/upsell/{toggle}": {
"put": {
"tags": [
"upsell-admin"
],
"operationId": "put-upsell-toggle-active-inactive",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"responses": {
"202": {
"description": "Апселл в проекте был активирован или деактивирован."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"name": "toggle",
"in": "path",
"required": true,
"description": "Статус активации.",
"schema": {
"type": "string",
"example": "activate"
}
}
],
"summary": "Активация/деактивация апселла в проекте",
"description": "Меняет статус апселла в проекте: активирует или деактивирует.
\n\n\n Уведомление
\n Этот метод использует JWT пользователя для авторизации.
\n Передайте токен в заголовке Authorization в формате Bearer <user_JWT>. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода.\n
"
}
},
"/v2/project/{project_id}/items/upsell": {
"get": {
"tags": [
"upsell-client"
],
"operationId": "get-upsell-for-project-client",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Upsell-200-get-client-list"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"summary": "Получение списка товаров для апселла в проекте",
"description": "Получает список товаров для апселла в проекте, если они уже настроены.
\n\n\n Примечание
\n Этот метод использует JWT пользователя для авторизации.
\n Передайте токен в заголовке Authorization в формате: Bearer <user_JWT>. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода.\n
"
}
},
"/projects/{project_id}/admin/program": {
"servers": [
{
"url": "https://loyalty-points.xsolla.com"
}
],
"get": {
"summary": "Получение информации о программе лояльности",
"description": "Возвращает информацию о программе лояльности проекта.",
"tags": [
"loyalty-program-admin"
],
"operationId": "loyalty-get-programs",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-get-loyalty-program"
},
"401": {
"$ref": "#/components/responses/401-invalid-auth"
},
"404": {
"$ref": "#/components/responses/404-program-not-found"
}
}
}
},
"/projects/{project_id}/admin/programs/{loyalty_program_id}/loyalty_points": {
"servers": [
{
"url": "https://loyalty-points.xsolla.com"
}
],
"get": {
"summary": "Получение списка баллов лояльности в программе",
"description": "Возвращает список баллов лояльности в программе.",
"tags": [
"loyalty-program-admin"
],
"operationId": "loyalty-get-program-loyalty-points",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/loyalty_program_id-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-get-program-loyalty-points"
},
"401": {
"$ref": "#/components/responses/401-invalid-auth"
}
}
}
},
"/projects/{project_id}/users/{user_id}/points/{point_id}/balance": {
"servers": [
{
"url": "https://loyalty-points.xsolla.com"
}
],
"get": {
"summary": "Получение баланса баллов лояльности пользователя",
"description": "Возвращает текущий баланс указанных баллов лояльности.",
"tags": [
"loyalty-program-admin"
],
"operationId": "loyalty-get-user-point-balance",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/user_id-path-param"
},
{
"$ref": "#/components/parameters/point_id-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-get-point-balance"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-user-or-point-not-found"
}
}
}
},
"/projects/{project_id}/users/{user_id}/points/{point_id}/balance/debit": {
"servers": [
{
"url": "https://loyalty-points.xsolla.com"
}
],
"post": {
"summary": "Списание баллов лояльности у пользователя",
"description": "Списывает указанное количество баллов лояльности с баланса пользователя.",
"tags": [
"loyalty-program-admin"
],
"operationId": "loyalty-debit-user-point-balance",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/user_id-path-param"
},
{
"$ref": "#/components/parameters/point_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/debit-point-balance"
},
"responses": {
"200": {
"$ref": "#/components/responses/200-debit-point-balance"
},
"400": {
"$ref": "#/components/responses/400-bad-request"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-user-or-point-not-found"
},
"422": {
"$ref": "#/components/responses/422-insufficient-balance"
}
}
}
},
"/projects/{project_id}/users/{user_id}/points/{point_id}/balance/credit": {
"servers": [
{
"url": "https://loyalty-points.xsolla.com"
}
],
"post": {
"summary": "Начисление баллов лояльности пользователю",
"description": "Начисляет указанное количество баллов лояльности на баланс пользователя.",
"tags": [
"loyalty-program-admin"
],
"operationId": "loyalty-credit-user-point-balance",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/user_id-path-param"
},
{
"$ref": "#/components/parameters/point_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/credit-point-balance"
},
"responses": {
"200": {
"$ref": "#/components/responses/200-credit-point-balance"
},
"400": {
"$ref": "#/components/responses/400-bad-request"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-user-or-point-not-found"
}
}
}
},
"/v1/projects/{project_id}/loyalty_point_balance": {
"servers": [
{
"url": "https://loyalty-points.xsolla.com"
}
],
"get": {
"summary": "Получение баланса баллов лояльности пользователя",
"description": "Возвращает текущий баланс баллов лояльности.",
"tags": [
"loyalty-program-client"
],
"operationId": "loyalty-get-user-balance",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"security": [
{
"XsollaLoginUserJWT": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-get-client-point-balance"
},
"401": {
"$ref": "#/components/responses/401-invalid-auth"
}
}
}
},
"/v2/project/{project_id}/payment/item/{item_sku}/loyalty_point/{loyalty_point_sku}": {
"post": {
"summary": "Создание заказа с указанным товаром, приобретаемым за баллы лояльности",
"description": "Создает заказ с указанным товаром, который полностью оплачивается баллами лояльности пользователя. Чтобы купить несколько товаров сразу, передайте их количество в параметре `quantity`.",
"tags": [
"loyalty-program-client"
],
"operationId": "loyalty-create-order-with-item-for-loyalty-points",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"security": [
{
"XsollaLoginUserJWT": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
},
{
"$ref": "#/components/parameters/loyalty_point_sku-path-param"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"quantity": {
"type": "number",
"description": "Number of items to purchase. `1` by default."
}
}
},
"example": {
"quantity": 2
}
}
}
},
"responses": {
"200": {
"$ref": "#/components/responses/200-purchase-by-loyalty-points"
},
"422": {
"$ref": "#/components/responses/422-purchase-by-loyalty-points"
}
}
}
}
},
"components": {
"securitySchemes": {
"basicAuth": {
"type": "http",
"description": "Для серверных методов используется схема аутентификации `basicAuth`. Все запросы к API должны содержать заголовок `Authorization: Basic `, где `your_authorization_basic_key` — пара `project_id:api_key`, закодированная по стандарту Base64.\n\nВы можете использовать `merchant_id` вместо `project_id` при необходимости. Это не влияет на функциональность.\n\nЗначения параметров вы можете найти в [Личном кабинете](https://publisher.xsolla.com/):\n\n* `merchant_id` отображается:\n * В разделе **Настройки компании > Компания**\n * В адресной строке браузера на любой странице Личного кабинета. URL-адрес имеет вид: `https://publisher.xsolla.com/`.\n* `api_key` отображается в Личном кабинете только при создании и должен храниться на вашей стороне. Создать ключ можно в разделах:\n * [Настройки компании > Ключи API](https://publisher.xsolla.com/0/settings/api_key)\n * [Настройки проекта > Ключи API](https://publisher.xsolla.com/0/projects/0/edit/api_key)\n\n{% html name=\"div\" attrs={\"class\": \"notice\"} %}\n**Внимание**\n\nЕсли необходимый метод API не включает в себя path-параметр `project_id`, используйте для авторизации ключ API, который действует во всех проектах.\n{% /html %}\n\n* `project_id` отображается:\n * В Личном кабинете рядом с названием проекта.\n * В адресной строке браузера при работе с проектом в Личном кабинете. URL-адрес имеет вид: `https://publisher.xsolla.com//projects/`.\n\nПодробная информация о работе с ключами API приведена в [справочнике API](https://developers.xsolla.com/ru/api/getting-started/#api_keys_overview).",
"scheme": "basic"
},
"XsollaLoginUserJWT": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT",
"description": "Для клиентских методов используется схема аутентификации `XsollaLoginUserJWT`. Запрос должен содержать JWT пользователя в заголовке `Authorization` в формате Bearer ``. Токен идентифицирует пользователя и обеспечивает доступ к персонализированным данным. Подробная информация о создании токена приведена в [документации Xsolla Login API](/ru/api/login/authentication-schemes#getting-user-token).\n\nВ качестве альтернативы вы можете использовать [токен для открытия платежного интерфейса](/ru/api/pay-station/token/create-token)."
},
"AuthForCart": {
"type": "http",
"scheme": "bearer",
"description": "Для продажи корзины используется схема аутентификации `AuthForCart`, которая поддерживает два режима:\n\n1. Аутентификация с использованием JWT пользователя. Токен передается в заголовке Authorization в следующем формате: `Authorization: Bearer `, где `` — это токен пользователя. Токен идентифицирует пользователя и предоставляет доступ к персонализированным данным.\n\nВ качестве альтернативы вы можете использовать [токен для открытия платежного интерфейса](/ru/api/pay-station/token/create-token).\n\n2. Упрощенный режим без заголовка `Authorization`. Он применяется только для неавторизованных пользователей и может быть использована только для [продажи игровых ключей](/ru/doc/buy-button/how-to/set-up-authentication/#guides_buy_button_selling_items_not_authenticated_users). Вместо токена в запрос передаются специальные заголовки:\n* `x-unauthorized-id` с ID запроса;\n* `x-user` с email пользователя, закодированным по стандарту Base64."
},
"basicMerchantAuth": {
"type": "http",
"description": "Для серверных методов используется схема аутентификации `basicMerchantAuth`. Все запросы к API должны содержать заголовок `Authorization: Basic `, где `your_authorization_basic_key` — пара `merchant_id:api_key`, закодированная по стандарту Base64.\n\nЗначения параметров вы можете найти в [Личном кабинете](https://publisher.xsolla.com/):\n\n* `merchant_id` отображается:\n * В разделе **Настройки компании > Компания**\n * В адресной строке браузера на любой странице Личного кабинета. URL-адрес имеет вид: `https://publisher.xsolla.com/`\n* `api_key` отображается в Личном кабинете только при создании и должен храниться на вашей стороне. Создать ключ можно в разделе [Настройки компании > Ключи API](https://publisher.xsolla.com/0/settings/api_key).\n\nПодробная информация о работе с ключами API приведена в [справочнике API](https://developers.xsolla.com/ru/api/getting-started/#api_keys_overview).",
"scheme": "basic"
}
},
"parameters": {
"project_id-path-param": {
"name": "project_id",
"in": "path",
"required": true,
"description": "ID проекта. Вы можете найти этот параметр в [Личном кабинете](https://publisher.xsolla.com/0/projects/0/) рядом с названием проекта, а также в адресной строке браузера при работе с проектом. URL-адрес имеет следующий формат: `https://publisher.xsolla.com//projects/`.",
"schema": {
"type": "integer",
"example": 44056
}
},
"limit-query-param": {
"name": "limit",
"in": "query",
"example": 50,
"required": false,
"description": "Лимит количества элементов на странице.",
"schema": {
"type": "integer",
"example": 50,
"minimum": 1
}
},
"offset-query-param": {
"name": "offset",
"in": "query",
"required": false,
"example": 0,
"description": "Номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0).",
"schema": {
"type": "integer",
"example": 0,
"minimum": 0
}
},
"enabled-query-param": {
"name": "enabled",
"in": "query",
"required": false,
"description": "Фильтрует элементы по флагу `is_enabled`.",
"schema": {
"type": "integer"
}
},
"promotion_id-path-param": {
"name": "promotion_id",
"in": "path",
"required": true,
"description": "ID акции. Уникальный идентификатор акции в рамках проекта.",
"schema": {
"type": "integer",
"example": 111425
}
},
"code-path-param": {
"name": "code",
"in": "path",
"required": true,
"description": "Уникальный код, чувствительный к регистру. Содержит буквы и цифры.",
"schema": {
"type": "string",
"example": "WINTER2021",
"minLength": 1,
"maxLength": 128
}
},
"coupon_code-path-param": {
"name": "coupon_code",
"in": "path",
"required": true,
"description": "Уникальный код, чувствительный к регистру. Содержит буквы и цифры.",
"schema": {
"type": "string",
"example": "WINTER2021",
"minLength": 1,
"maxLength": 128
}
},
"external_id-promotion-path-param": {
"name": "external_id",
"in": "path",
"required": true,
"description": "External ID акции. Уникальный идентификатор акции в рамках проекта.",
"schema": {
"type": "integer",
"example": "coupon_44056_1"
}
},
"promocode_code-path-param": {
"name": "promocode_code",
"in": "path",
"required": true,
"description": "Уникальный код, чувствительный к регистру. Содержит буквы и цифры.",
"schema": {
"type": "string",
"example": "SO6rew99j9",
"minLength": 1,
"maxLength": 128
}
},
"user_external_id-query-param": {
"name": "user_external_id",
"in": "query",
"required": true,
"description": "External ID пользователя",
"schema": {
"type": "string",
"example": "d342dad2-9d59-11e9-a384-42010aa8003f"
}
},
"codes-query-param": {
"name": "codes[]",
"in": "query",
"description": "Уникальные коды, чувствительные к регистру. Содержат только буквы и цифры.",
"schema": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
}
},
"is_enabled-query-param": {
"name": "is_enabled",
"in": "query",
"required": false,
"description": "Фильтрует элементы по флагу `is_enabled`.",
"schema": {
"type": "integer"
}
},
"personalized-catalog-rule_id-path-param": {
"name": "rule_id",
"in": "path",
"required": true,
"description": "ID правила.",
"schema": {
"type": "number",
"example": 1
}
},
"item_sku-path-param": {
"name": "item_sku",
"in": "path",
"required": true,
"description": "Артикул товара.",
"schema": {
"type": "string",
"example": "booster_mega_1"
}
},
"value_point_sku-path-param": {
"name": "value_point_sku",
"in": "path",
"required": true,
"description": "Value Point SKU.",
"schema": {
"type": "string",
"example": "value_point_3"
}
},
"reward_chain_id-path-param": {
"name": "reward_chain_id",
"in": "path",
"required": true,
"description": "ID цепочки наград.",
"schema": {
"type": "integer",
"example": 101
}
},
"reward_chain_step_id-path-param": {
"name": "step_id",
"in": "path",
"required": true,
"description": "ID уровня цепочки наград.",
"schema": {
"type": "integer",
"example": 120
}
},
"is_expired-daily-chain-query-param": {
"name": "is_expired",
"in": "query",
"required": false,
"description": "Фильтруйте ежедневные награды, чтобы показывать только те, у которых срок действия истек.",
"schema": {
"type": "integer"
}
},
"type-daily-chain-query-param": {
"name": "type",
"in": "query",
"required": false,
"description": "Фильтрует ежедневные награды, чтобы возвращать только указанный тип.",
"schema": {
"type": "string",
"enum": [
"calendar_hard",
"rolling_skippable",
"rolling_unskippable"
]
}
},
"daily_chain_id-path-param": {
"name": "daily_chain_id",
"in": "path",
"required": true,
"description": "ID ежедневной награды.",
"schema": {
"type": "integer",
"example": 101
}
},
"daily_chain_step_number-path-param": {
"name": "step_number",
"in": "path",
"required": true,
"description": "Номер уровня ежедневной награды.",
"schema": {
"type": "integer",
"example": 1
}
},
"offer_chain_id-path-param": {
"name": "offer_chain_id",
"in": "path",
"required": true,
"description": "ID цепочки предложений.",
"schema": {
"type": "integer",
"example": 101
}
},
"offer_chain_step_number-path-param": {
"name": "step_number",
"in": "path",
"required": true,
"description": "Номер уровня в цепочке предложений.",
"schema": {
"type": "integer",
"example": 1
}
},
"loyalty_program_id-path-param": {
"name": "loyalty_program_id",
"in": "path",
"required": true,
"description": "ID программы лояльности. Чтобы получить ID, вызовите метод Получение информации о программе лояльности.",
"schema": {
"type": "string",
"example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
},
"user_id-path-param": {
"name": "user_id",
"in": "path",
"required": true,
"description": "ID пользователя на вашей стороне. Должен совпадать с ID, который вы передаете в параметре `user.id` при [создании токена оплаты](https://developers.xsolla.com/ru/api/pay-station/token/create-token), так как баллы лояльности привязываются к этому ID.",
"schema": {
"type": "string",
"example": "d342dad2-9d59-11e9-a384-42010aa8003f"
}
},
"point_id-path-param": {
"name": "point_id",
"in": "path",
"required": true,
"description": "ID баллов лояльности. Баллы лояльности настраиваются в Личном кабинете в разделе [LiveOps-инструменты > Программа лояльности](https://publisher.xsolla.com/0/projects/0/storefront/loyalty-program). Чтобы получить ID, вызовите [метод получения каталога](https://developers.xsolla.com/ru/api/catalog/virtual-items-currency-catalog/get-virtual-items) — ID возвращается в параметре `loyalty_rewards[].sku`.",
"schema": {
"type": "string",
"format": "uuid",
"example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
},
"loyalty_point_sku-path-param": {
"name": "loyalty_point_sku",
"in": "path",
"required": true,
"description": "Артикул баллов лояльности.",
"schema": {
"type": "string",
"example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
}
},
"schemas": {
"Promotions_promotion_id": {
"type": "integer",
"description": "ID акции. Уникальный идентификатор акции в рамках проекта.",
"example": 1
},
"promotion_periods": {
"type": "array",
"nullable": false,
"description": "Периоды действия акции. Если указано больше одного периода, параметры `date_from` и `date_until` становятся обязательными.",
"items": {
"type": "object",
"properties": {
"date_from": {
"type": "string",
"format": "date-time",
"nullable": false,
"example": "2020-08-11T10:00:00+03:00",
"description": "Дата начала действия указанной акции."
},
"date_until": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2020-08-11T20:00:00+03:00",
"description": "Дата окончания действия указанной акции. Если передано значение `null`, акция является бессрочной. Может быть `null`, только если указан один период действия."
}
},
"required": [
"date_from"
]
}
},
"Promotions_coupon_name": {
"type": "object",
"description": "Название акции. Данный параметр должен содержать пары ключ/значение,\nгде ключ — это локаль в формате \"^[a-z]{2}-[A-Z]{2}$\", значение — строка.",
"additionalProperties": {
"type": "string"
},
"example": {
"en-US": "Coupon title",
"de-DE": "Gutscheintitel"
},
"default": {
"en-US": "Coupon title",
"de-DE": "Gutscheintitel"
}
},
"unit_items": {
"type": "array",
"description": "Массив с игровыми ключами для конкретных платформ. Используется только если тип товара — `unit` (`bonus.item.type = 'unit'`). Если пакет содержит ключи для нескольких платформ, пользователь может выбрать один из них в качестве бонуса.",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "cool_game_steam",
"pattern": "^[a-zA-Z0-9_\\-.]*$",
"description": "Артикул пакета игровых ключей для конкретной платформы. Допустимые символы: a–z, A–Z, 0–9, точка (`.`), дефис (`-`), подчеркивание (`_`). Состоит из значений `bonus.item.sku` и `bonus.item.unit_items.drm_sku`. Например, если `bonus.item.sku = 'cool_game'` и `bonus.item.unit_items.drm_sku = 'steam'`, значение будет `cool_game_steam`."
},
"is_free": {
"type": "boolean"
},
"type": {
"type": "string",
"enum": [
"game_key"
],
"description": "Параметр для обозначения игровых ключей."
},
"name": {
"type": "string",
"example": "Awesome Game",
"description": "Название игры."
},
"drm_name": {
"type": "string",
"example": "Steam",
"description": "Название платформы распространения игры."
},
"drm_sku": {
"type": "string",
"pattern": "^[a-zA-Z0-9_\\-.]*$",
"example": "steam",
"description": "Уникальный ID платформы распространения игры. Используется как суффикс для обозначения ключей для конкретных платформ. Допустимые символы: a–z, A–Z, 0–9, точка (`.`), дефис (`-`), подчеркивание (`_`)."
}
}
}
},
"Promotions_200-coupon-bonus-reward": {
"type": "object",
"properties": {
"item": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "game_01",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"name": {
"type": "object",
"example": {
"en": "Game name"
},
"description": "Название товара."
},
"type": {
"type": "string",
"example": "unit",
"description": "Тип товара. Возможные значения:virtual_good — виртуальные товары;virtual_currency — виртуальная валюта;bundle — бандл;unit — пакет игровых ключей.
"
},
"bundle_type": {
"type": "string",
"description": "Тип бандла. Возвращается, если тип элемента является бандлом.",
"enum": [
"standard",
"virtual_currency_package"
]
},
"description": {
"type": [
"string",
"null"
],
"example": "Game description",
"description": "Описание товара."
},
"image_url": {
"type": [
"string",
"null"
],
"example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"description": "URL-адрес изображения."
},
"content": {
"type": "array"
},
"unit_items": {
"$ref": "#/components/schemas/unit_items"
}
}
},
"quantity": {
"type": "number",
"description": "Количество товаров.",
"default": 1
}
}
},
"Promotions_sku": {
"type": "string",
"example": "booster_mega_1",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"Promotions_name": {
"type": "object",
"description": "Название товара. Данный параметр должен содержать пары ключ/значение,\nгде ключ — это локаль в формате \"^[a-z]{2}-[A-Z]{2}$\", значение — строка.",
"additionalProperties": {
"type": "string"
},
"example": {
"en-US": "Item title",
"de-DE": "Artikeltitel"
},
"default": {
"en-US": "Item title",
"de-DE": "Artikeltitel"
}
},
"Promotions_type": {
"type": "string",
"description": "Тип товара: `virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`."
},
"Promotions_redeem_code_limit": {
"type": [
"integer",
"null"
],
"description": "Количество погашений по коду.",
"example": 10,
"default": 10
},
"Promotions_promotion_condition": {
"type": [
"array",
"null"
],
"items": {
"description": "Список товаров, за которые пользователь получил бонус.",
"type": "object",
"properties": {
"item": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Promotions_sku"
},
"name": {
"$ref": "#/components/schemas/Promotions_name"
},
"type": {
"$ref": "#/components/schemas/Promotions_type"
},
"description": {
"type": [
"string",
"null"
],
"example": "Game description",
"description": "Описание товара."
},
"image_url": {
"type": [
"string",
"null"
],
"example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"description": "URL-адрес изображения."
},
"external_id": {
"type": "string",
"description": "External ID акции. Уникальный идентификатор акции в рамках проекта.",
"minLength": 1,
"maxLength": 255,
"pattern": "^[-_.\\d\\w]+$"
},
"is_enabled": {
"type": "boolean"
},
"redeem_total_limit": {
"type": [
"integer",
"null"
]
},
"redeem_user_limit": {
"type": [
"integer",
"null"
]
},
"redeem_code_limit": {
"$ref": "#/components/schemas/Promotions_redeem_code_limit"
}
}
}
}
}
},
"Promotions_coupon-is_enabled": {
"type": "boolean",
"default": true
},
"Promotions_promotion_type": {
"type": "string",
"description": "Тип акции.",
"example": "item_discount"
},
"Promotions_promotion_discount_percent": {
"type": [
"string",
"null"
],
"description": "Процент скидки.\nЦена корзины будет уменьшена с использованием значения, рассчитанного с использованием этого процента, а затем округлена до 2 знаков после запятой.",
"default": "10.00",
"example": "10.00"
},
"promotion_recurrent_schedule_response": {
"type": [
"object",
"null"
],
"description": "Период обновления установленный ограничений.",
"properties": {
"per_user": {
"description": "Период обновления установленный ограничений для пользователя.",
"oneOf": [
{
"type": "object",
"title": "interval_type = daily",
"description": "Ежедневное обновление пользовательских ограничений.",
"properties": {
"interval_type": {
"type": "string",
"description": "Период обновления ограничения на продажу товара.",
"enum": [
"daily"
]
},
"time": {
"type": "string",
"description": "Время обновления ограничений в желаемом часовом поясе (округление до часов).",
"format": "full-time",
"example": "11:00:00+03:00"
},
"reset_next_date": {
"type": "integer",
"description": "Дата и время, когда ограничения обновляются (Unix Timestamp).",
"example": 1677553200
},
"displayable_reset_start_date": {
"description": "Дата и время первого обновления ограничений (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
},
"displayable_reset_next_date": {
"description": "Дата и время, когда ограничения должны быть сброшены (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
}
}
},
{
"type": "object",
"title": "interval_type = weekly",
"description": "Еженедельное обновление пользовательских ограничений.",
"properties": {
"interval_type": {
"type": "string",
"description": "Период обновления ограничения на продажу товара.",
"enum": [
"weekly"
]
},
"day_of_week": {
"type": [
"integer",
"null"
],
"description": "День недели, когда обновляются ограничения: 1 — понедельник, 7 — воскресенье. Не `null` только для типа периода `weekly`.",
"minimum": 1,
"maximum": 7
},
"time": {
"type": "string",
"description": "Время обновления ограничений в желаемом часовом поясе (округление до часов).",
"format": "full-time",
"example": "11:00:00+03:00"
},
"reset_next_date": {
"type": "integer",
"description": "Дата и время, когда ограничения обновляются (Unix Timestamp).",
"example": 1677553200
},
"displayable_reset_start_date": {
"description": "Дата и время первого обновления ограничений (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
},
"displayable_reset_next_date": {
"description": "Дата и время, когда ограничения должны быть сброшены (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
}
}
},
{
"type": "object",
"title": "interval_type = monthly",
"description": "Ежемесячное обновление пользовательских ограничений.",
"properties": {
"interval_type": {
"type": "string",
"description": "Период обновления ограничения на продажу товара.",
"enum": [
"monthly"
]
},
"day_of_month": {
"type": [
"integer",
"null"
],
"description": "День месяца, когда обновляются ограничения. Если в месяце нет выбранного дня, поскольку он короче, обновление произойдет в последний день месяца. Не `null` только для периода с типом `monthly`.",
"minimum": 1,
"maximum": 31
},
"time": {
"type": "string",
"description": "Время обновления ограничений в желаемом часовом поясе (округление до часов).",
"format": "full-time",
"example": "11:00:00+03:00"
},
"reset_next_date": {
"type": "integer",
"description": "Дата и время, когда ограничения обновляются (Unix Timestamp).",
"example": 1677553200
},
"displayable_reset_start_date": {
"description": "Дата и время первого обновления ограничений (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
},
"displayable_reset_next_date": {
"description": "Дата и время, когда ограничения должны быть сброшены (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
}
}
},
{
"type": "null",
"title": "null"
}
]
}
}
},
"Promotions_promotion_limits_response": {
"type": "object",
"description": "Ограничения акции.",
"properties": {
"per_user": {
"type": [
"object",
"null"
],
"description": "Ограничение количества использований акций отдельным пользователем.",
"properties": {
"total": {
"type": "integer",
"description": "Общее количество единиц товара, которое может купить пользователь. Вы можете установить данное значение в Личном кабинете или использовать методы администратора для сущностей магазина (объект limits).",
"example": 5
}
}
},
"per_item": {
"type": [
"integer",
"null"
],
"description": "Глобальное ограничение товара.",
"example": 10
},
"recurrent_schedule": {
"$ref": "#/components/schemas/promotion_recurrent_schedule_response"
}
}
},
"Promotions_200-get-promotion-model": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/Promotions_promotion_id"
},
"promotion_periods": {
"$ref": "#/components/schemas/promotion_periods"
},
"name": {
"$ref": "#/components/schemas/Promotions_coupon_name"
},
"bonus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Promotions_200-coupon-bonus-reward"
}
},
"condition": {
"$ref": "#/components/schemas/Promotions_promotion_condition"
},
"is_enabled": {
"$ref": "#/components/schemas/Promotions_coupon-is_enabled"
},
"type": {
"$ref": "#/components/schemas/Promotions_promotion_type"
},
"discount": {
"type": [
"object",
"null"
],
"properties": {
"percent": {
"$ref": "#/components/schemas/Promotions_promotion_discount_percent"
}
},
"example": {
"discount": {
"percent": "10.99"
}
}
},
"limits": {
"$ref": "#/components/schemas/Promotions_promotion_limits_response"
}
}
},
"total_promotions_count": {
"type": "integer",
"description": "Общее количество акций."
},
"active_promotions_count": {
"type": "integer",
"description": "Количество активных акций."
},
"inactive_promotions_count": {
"type": "integer",
"description": "Количество отключенных акций."
},
"Promotions_coupon-external_id": {
"type": "string",
"example": "coupon_external_id",
"default": "coupon_external_id",
"description": "Уникальный ID акции. `external_id` может содержать только строчные и заглавные латинские буквы, цифры, тире и подчеркивания."
},
"Promotions_coupon_bonus": {
"type": [
"array",
"null"
],
"items": {
"description": "Список товаров, которые будут добавлены в покупку пользователя в качестве бонуса.",
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "Артикул товара.",
"default": "elven_shield"
},
"quantity": {
"type": "number",
"description": "Количество товаров.",
"default": 1
}
}
}
},
"Promotions_coupon-redeem_total_limit": {
"type": [
"integer",
"null"
],
"description": "Ограничивает общее количество купонов.",
"example": 10,
"default": 10
},
"Promotions_coupon-redeem_user_limit": {
"type": [
"integer",
"null"
],
"description": "Ограничивает общее количество купонов, погашаемых одним пользователем.",
"example": 10,
"default": 10
},
"Promotions_coupon_total_limit_state": {
"type": [
"object",
"null"
],
"description": "Ограничения для каждого уникального кода купона.",
"properties": {
"available": {
"type": "integer",
"description": "Оставшееся количество использований купона.",
"example": 3
},
"reserved": {
"type": "integer",
"description": "Зарезервированное количество купонов.",
"example": 3
},
"used": {
"type": "integer",
"description": "Сколько раз использовался купон.",
"example": 5
}
}
},
"Promotions_cart_item_discount": {
"type": "string",
"nullable": false,
"description": "Процент скидки.\n\nЦена товара в корзине будет уменьшена с использованием значения,\nрассчитанного с использованием этого процента, а затем округлена\nдо 2 знаков после запятой.",
"default": "10.00",
"example": "10.00"
},
"admin-promotions_200-get-redeemable-coupon-promotion-model": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/Promotions_coupon-external_id"
},
"promotion_periods": {
"$ref": "#/components/schemas/promotion_periods"
},
"name": {
"$ref": "#/components/schemas/Promotions_coupon_name"
},
"bonus": {
"$ref": "#/components/schemas/Promotions_coupon_bonus"
},
"is_enabled": {
"$ref": "#/components/schemas/Promotions_coupon-is_enabled"
},
"redeem_total_limit": {
"$ref": "#/components/schemas/Promotions_coupon-redeem_total_limit"
},
"redeem_user_limit": {
"$ref": "#/components/schemas/Promotions_coupon-redeem_user_limit"
},
"redeem_code_limit": {
"$ref": "#/components/schemas/Promotions_redeem_code_limit"
},
"total_limit_state": {
"$ref": "#/components/schemas/Promotions_coupon_total_limit_state"
},
"discount": {
"type": [
"object",
"null"
],
"description": "Только для промокодов.",
"properties": {
"percent": {
"type": [
"string",
"null"
],
"description": "Процент скидки.\nЦена корзины будет уменьшена с использованием значения, рассчитанного с использованием этого процента, а затем округлена до 2 знаков после запятой.",
"default": "10.00",
"example": "10.00"
}
},
"example": {
"discount": {
"percent": "10.99"
}
}
},
"discounted_items": {
"type": [
"array",
"null"
],
"description": "Список товаров, на которые действует скидка по промокоду. Только для промокодов.",
"items": {
"description": "Скидка на определенные товары в корзине.",
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "Артикул товара.",
"default": "elven_shield"
},
"discount": {
"type": "object",
"nullable": false,
"properties": {
"percent": {
"$ref": "#/components/schemas/Promotions_cart_item_discount"
}
},
"required": [
"percent"
]
}
},
"required": [
"sku",
"discount"
],
"minItems": 1
}
}
}
},
"Promotions_selected_unit_items": {
"type": "object",
"description": "Игровой ключ для конкретной платформы, который выбрал пользователь в качестве бонуса. Передайте [полученный](/ru/api/liveops/promotions-coupons/get-coupon-rewards-by-code#promotions-coupons/get-coupon-rewards-by-code/t=response&c=200&path=bonus/item) `bonus.item.sku` в качестве ключа, а выбранный `bonus.item.unit_items.sku` в качестве его значения.",
"additionalProperties": {
"type": "string"
},
"example": {
"game_1": "game_1_steam",
"game_2": "game_2_playstation"
}
},
"Promotions_200-coupon-discount-reward": {
"type": [
"object",
"null"
],
"description": "Процент скидки.\nЦена корзины будет уменьшена с использованием значения, рассчитанного с использованием этого процента, а затем округлена до 2 знаков после запятой.",
"properties": {
"percent": {
"type": "string",
"example": "10.00"
}
}
},
"Promotions_422_limit_error": {
"description": "Достигнут лимит погашения.",
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 9804
},
"errorMessage": {
"type": "string",
"example": "[0401-9804]: You have reached the coupon redemption limit."
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"example": {
"statusCode": 422,
"errorCode": 9804,
"errorMessage": "[0401-9804]: You have reached the coupon redemption limit."
}
},
"Promotions_422_reglock_error": {
"description": "Купон недоступен в регионе пользователя.",
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 9808
},
"errorMessage": {
"type": "string",
"example": "[0401-9808]: Coupon is not available in your region."
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"example": {
"statusCode": 422,
"errorCode": 9804,
"errorMessage": "[0401-9804]: You have reached the coupon redemption limit."
}
},
"user-attribute_conditions_properties_attribute": {
"type": "string",
"description": "Код атрибута пользователя.",
"minLength": 1,
"maxLength": 255,
"pattern": "^[-_.\\d\\w]+$"
},
"user-attribute_conditions_properties_type-string": {
"type": "string",
"enum": [
"string"
],
"description": "Тип атрибута пользователя."
},
"user-attribute_conditions_properties_operator_string": {
"type": "string",
"enum": [
"eq",
"ne"
],
"description": "Тип операции, выполняемой по условию. Для типа атрибута string.\n\nPossible values:\n- `eq` — Equals\n- `ne` — Not equals"
},
"user-attribute_conditions_properties_value": {
"type": "string",
"description": "Значение условия, с которым будет сравниваться значение атрибута пользователя. Тип зависит от типа атрибута.",
"maxLength": 255
},
"user-attribute_conditions_properties_can_be_missing": {
"type": "boolean",
"description": "Считается ли условие выполненным, если этот атрибут отсутствует в атрибутах пользователя. Передайте `true`, чтобы показывать товар пользователям, у которых нет этого атрибута. Пользователи у которых атрибут есть, но значение не совпадает с указанным в условии, не увидят товар. `false` — пользователи у которых атрибут есть, но значение не совпадает с указанным в условии, или атрибута нет, не увидят товар."
},
"user-attribute_condition_string_model-get": {
"type": "object",
"title": "type = string",
"properties": {
"attribute": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_attribute"
},
"type": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_type-string"
},
"operator": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_operator_string"
},
"value": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_value"
},
"can_be_missing": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_can_be_missing"
}
}
},
"user-attribute_conditions_properties_type-number": {
"type": "string",
"enum": [
"number"
],
"description": "Тип атрибута пользователя."
},
"user-attribute_conditions_properties_operator_number": {
"type": "string",
"enum": [
"eq",
"ne",
"gt",
"ge",
"lt",
"le"
],
"description": "Тип операции, выполняемой по условию. Для типа атрибута number.\n\nPossible values:\n- `eq` — Equals\n- `ne` — Not equals\n- `gt` — Greater\n- `ge` — Greater or equals\n- `lt` — Less\n- `le` — Less or equals"
},
"user-attribute_condition_number_model-get": {
"type": "object",
"title": "type = number",
"properties": {
"attribute": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_attribute"
},
"type": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_type-number"
},
"operator": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_operator_number"
},
"value": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_value"
},
"can_be_missing": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_can_be_missing"
}
}
},
"user-attribute_conditions_properties_type-date": {
"type": "string",
"enum": [
"date"
],
"description": "Тип атрибута пользователя."
},
"user-attribute_conditions_properties_operator_date": {
"type": "string",
"enum": [
"eq",
"ne",
"lt",
"gt",
"le",
"ge"
],
"description": "Тип операции, выполняемой по условию. Для типа атрибута date.\n\nPossible values:\n- `eq` — Equals\n- `ne` — Not equals\n- `lt` — Earlier\n- `gt` — Later\n- `le` — Earlier or equals\n- `ge` — Later or equals"
},
"user-attribute_condition_date_model-get": {
"type": "object",
"title": "type = date",
"properties": {
"attribute": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_attribute"
},
"type": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_type-date"
},
"operator": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_operator_date"
},
"value": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_value"
},
"can_be_missing": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_can_be_missing"
}
}
},
"user-attribute_conditions_model-get": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/user-attribute_condition_string_model-get"
},
{
"$ref": "#/components/schemas/user-attribute_condition_number_model-get"
},
{
"$ref": "#/components/schemas/user-attribute_condition_date_model-get"
}
]
}
},
"promotion_user-attribute_conditions_model-get": {
"allOf": [
{
"$ref": "#/components/schemas/user-attribute_conditions_model-get"
},
{
"description": "Условия для проверки атрибутов пользователя.\nОпределяют доступность цепочки на основе соответствия атрибутов пользователя всем указанным условиям."
}
]
},
"admin-promotions_200-get-coupon-promotion-model": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/Promotions_coupon-external_id"
},
"promotion_periods": {
"$ref": "#/components/schemas/promotion_periods"
},
"name": {
"$ref": "#/components/schemas/Promotions_coupon_name"
},
"bonus": {
"$ref": "#/components/schemas/Promotions_coupon_bonus"
},
"is_enabled": {
"$ref": "#/components/schemas/Promotions_coupon-is_enabled"
},
"redeem_total_limit": {
"$ref": "#/components/schemas/Promotions_coupon-redeem_total_limit"
},
"redeem_user_limit": {
"$ref": "#/components/schemas/Promotions_coupon-redeem_user_limit"
},
"redeem_code_limit": {
"$ref": "#/components/schemas/Promotions_redeem_code_limit"
},
"total_limit_state": {
"$ref": "#/components/schemas/Promotions_coupon_total_limit_state"
},
"attribute_conditions": {
"$ref": "#/components/schemas/promotion_user-attribute_conditions_model-get"
}
}
},
"user-attribute_condition_string_model-post": {
"type": "object",
"title": "type = string",
"properties": {
"attribute": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_attribute"
},
"type": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_type-string"
},
"operator": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_operator_string"
},
"value": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_value"
},
"can_be_missing": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_can_be_missing"
}
},
"required": [
"attribute",
"operator",
"value",
"type"
]
},
"user-attribute_condition_number_model-post": {
"type": "object",
"title": "type = number",
"properties": {
"attribute": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_attribute"
},
"type": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_type-number"
},
"operator": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_operator_number"
},
"value": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_value"
},
"can_be_missing": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_can_be_missing"
}
},
"required": [
"attribute",
"operator",
"value",
"type"
]
},
"user-attribute_condition_date_model-post": {
"type": "object",
"title": "type = date",
"properties": {
"attribute": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_attribute"
},
"type": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_type-date"
},
"operator": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_operator_date"
},
"value": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_value"
},
"can_be_missing": {
"$ref": "#/components/schemas/user-attribute_conditions_properties_can_be_missing"
}
},
"required": [
"attribute",
"operator",
"value",
"type"
]
},
"user-attribute_conditions_model-post": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/user-attribute_condition_string_model-post"
},
{
"$ref": "#/components/schemas/user-attribute_condition_number_model-post"
},
{
"$ref": "#/components/schemas/user-attribute_condition_date_model-post"
}
]
}
},
"promotion_user-attribute_conditions_model-post": {
"allOf": [
{
"$ref": "#/components/schemas/user-attribute_conditions_model-post"
},
{
"description": "Условия для проверки атрибутов пользователя.\nОпределяют доступность цепочки на основе соответствия атрибутов пользователя всем указанным условиям."
}
]
},
"Promotions_coupon_code": {
"type": "string",
"description": "Уникальный код, чувствительный к регистру. Содержит буквы и цифры.",
"minLength": 1,
"maxLength": 128,
"example": "WINTER2021",
"default": "WINTER2021",
"pattern": "^[a-zA-Z0-9]+$"
},
"Promotions_coupon-generate-count": {
"type": "integer",
"minimum": 1,
"maximum": 50000,
"example": 10
},
"value-is_free": {
"type": "boolean",
"example": false,
"default": false,
"description": "Является ли товар бесплатным."
},
"Catalog_item_promotions": {
"type": "array",
"description": "Примененные акции для отдельных товаров в корзине. Массив возвращается, если:\n\n* Скидочная акция настроена для отдельного товара.\n\n* Используется промокод с настройкой **Скидка на выбранные товары**.\n\nЕсли акции на уровне отдельных товаров не применялись, возвращается пустой массив.",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"date_start": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"date_end": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"discount": {
"type": [
"object",
"null"
],
"properties": {
"percent": {
"type": [
"string",
"null"
]
},
"value": {
"type": [
"string",
"null"
]
}
}
},
"bonus": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"type": {
"type": "string",
"description": "Тип бонусного товара.",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"physical_good",
"game_key",
"nft"
]
},
"name": {
"type": "string",
"description": "Название бонусного товара. Недоступно для типа бонусного товара `physical_good`."
},
"image_url": {
"type": "string",
"description": "URL-адрес изображения бонусного бандла. Недоступно для типа бонусного товара `physical_good`."
},
"bundle_type": {
"type": "string",
"description": "Тип товара бонусного бандла. Доступно только для бонусного товара типа `bundle`.",
"enum": [
"standard",
"virtual_currency_package"
]
}
}
}
},
"limits": {
"type": "object",
"properties": {
"per_user": {
"type": "object",
"properties": {
"available": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
}
}
}
}
}
},
"Can_be_bought": {
"type": "boolean",
"example": true,
"description": "Если `true`, пользователь может купить товар."
},
"item_id": {
"type": "integer",
"example": 1,
"description": "Внутренний уникальный ID виртуального предмета или валюты."
},
"value-point-sku": {
"type": "string",
"description": "Уникальный ID призовых баллов."
},
"value-point-amount": {
"type": "integer",
"description": "Количество призовых баллов."
},
"value-point-name": {
"type": "string",
"description": "Название призовых баллов."
},
"Common_admin-image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "URL-адрес изображения."
},
"is_clan": {
"type": "boolean",
"description": "Может ли призовой балл использоваться в цепочках наград для клана.",
"example": true
},
"client-item-value-point-reward": {
"type": "array",
"description": "Список призовых баллов для товара.",
"items": {
"type": "object",
"properties": {
"item_id": {
"$ref": "#/components/schemas/item_id"
},
"sku": {
"$ref": "#/components/schemas/value-point-sku"
},
"amount": {
"$ref": "#/components/schemas/value-point-amount"
},
"name": {
"$ref": "#/components/schemas/value-point-name"
},
"image_url": {
"$ref": "#/components/schemas/Common_admin-image_url"
},
"is_clan": {
"$ref": "#/components/schemas/is_clan"
}
}
}
},
"loyalty-point-sku": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"example": "123e4567-e89b-12d3-a456-426614174000",
"description": "Артикул балла лояльности. Используйте это значение в параметре `loyalty_point_sku` в других запросах API, например при создании заказа, оплачиваемого баллами лояльности."
},
"image_url": {
"type": [
"string",
"null"
],
"example": "https://image.example.com",
"description": "URL-адрес изображения."
},
"item-loyalty-point-reward": {
"type": "array",
"description": "Баллы лояльности, которые пользователь получает в награду за покупку товара.",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Название баллов лояльности."
},
"sku": {
"$ref": "#/components/schemas/loyalty-point-sku"
},
"description": {
"type": "string",
"description": "Описание баллов лояльности."
},
"image_url": {
"$ref": "#/components/schemas/image_url"
},
"amount": {
"type": "integer",
"description": "Количество баллов лояльности, которое пользователь получает за покупку товара."
}
}
}
},
"catalog_recurrent_schedule_client_response": {
"description": "Период обновления ограничений на продажу товара для пользователя.",
"oneOf": [
{
"type": "object",
"title": "interval_type = daily",
"description": "Ежедневное обновление пользовательских ограничений.",
"properties": {
"interval_type": {
"type": "string",
"description": "Период обновления ограничения на продажу товара.",
"enum": [
"daily"
]
},
"reset_next_date": {
"type": "integer",
"description": "Дата и время, когда ограничения должны быть сброшены (Unix Timestamp).",
"example": 1677553200
}
}
},
{
"type": "object",
"title": "interval_type = weekly",
"description": "Еженедельное обновление пользовательских ограничений.",
"properties": {
"interval_type": {
"type": "string",
"description": "Период обновления ограничения на продажу товара.",
"enum": [
"weekly"
]
},
"reset_next_date": {
"type": "integer",
"description": "Дата и время, когда ограничения должны быть сброшены (Unix Timestamp).",
"example": 1677553200
}
}
},
{
"type": "object",
"title": "interval_type = monthly",
"description": "Ежемесячное обновление пользовательских ограничений.",
"properties": {
"interval_type": {
"type": "string",
"description": "Период обновления ограничения на продажу товара.",
"enum": [
"monthly"
]
},
"reset_next_date": {
"type": "integer",
"description": "Дата и время, когда ограничения должны быть сброшены (Unix Timestamp).",
"example": 1677553200
}
}
},
{
"type": "object",
"title": "interval_type = hourly",
"description": "Сброс ограничений для пользователя, выполняемый через временной интервал, заданный в часах.",
"properties": {
"interval_type": {
"type": "string",
"description": "Период обновления ограничения на продажу товара.",
"enum": [
"hourly"
]
},
"reset_next_date": {
"type": "integer",
"description": "Дата и время, когда ограничения должны быть сброшены (Unix Timestamp).",
"example": 1677553200
}
}
},
{
"type": "null",
"title": "null"
}
]
},
"limit_exceeded_visibility": {
"type": "string",
"example": "show",
"enum": [
"show",
"hide"
],
"description": "Определяет видимость товара в каталоге после достижения лимита покупок до момента следующего обновления лимитов.\n\nПрименяется к товарам, для которых задано регулярное обновление лимитов в массиве `recurrent_schedule`.\n\nЕсли обновление лимитов не задано, товар не отображается в каталоге после достижения лимита независимо от значения `limit_exceeded_visibility`.\n\nВозможные значения:\n- `show` — Товар возвращается в методах получения каталога товаров после достижения лимита покупок. В клиентских методах получения каталога после достижения лимита товар возвращается с флагом `can_be_bought: false`. Дата следующего сброса возвращается в `reset_next_date`.\n- `hide` — Товар не возвращается в методах получения каталога товаров после достижения лимита покупок до момента сброса лимитов.",
"default": "show"
},
"Catalog_item_limits": {
"description": "Ограничения на продажу товара.",
"properties": {
"per_user": {
"type": [
"object",
"null"
],
"description": "Ограничения на продажу товара для пользователя.",
"properties": {
"total": {
"type": "integer",
"description": "Максимальное количество товара, которое может приобрести один пользователь.",
"example": 5
},
"available": {
"type": "integer",
"description": "Оставшееся количество товара, которое может приобрести текущий пользователь.",
"example": 3
},
"recurrent_schedule": {
"$ref": "#/components/schemas/catalog_recurrent_schedule_client_response"
},
"limit_exceeded_visibility": {
"$ref": "#/components/schemas/limit_exceeded_visibility"
}
}
},
"per_item": {
"type": [
"object",
"null"
],
"description": "Ограничения на продажу для конкретного товара.",
"properties": {
"total": {
"type": "integer",
"description": "Максимальное количество товара, которое могут приобрести все пользователи.",
"example": 5
},
"available": {
"type": "integer",
"description": "Оставшееся количество товара, которое могут приобрести все пользователи.",
"example": 3
}
}
}
},
"type": [
"object",
"null"
]
},
"item-periods": {
"type": [
"array",
"null"
],
"description": "Период продажи товара.",
"items": {
"type": "object",
"properties": {
"date_from": {
"type": "string",
"format": "date-time",
"example": "2020-08-11T10:00:00+03:00",
"description": "Дата, когда указанный товар будет доступен для продажи."
},
"date_until": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2020-08-11T20:00:00+03:00",
"description": "Дата, когда указанный товар станет недоступен для продажи. Может быть `null`."
}
}
}
},
"Promotions_200-promo-code-bonus-reward": {
"type": "object",
"properties": {
"item": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "game_01",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"name": {
"type": "string",
"example": "Game name",
"description": "Название товара."
},
"type": {
"type": "string",
"example": "unit",
"description": "Тип товара. Возможные значения:virtual_good — виртуальные товары;virtual_currency — виртуальная валюта;bundle — бандл;unit — пакет игровых ключей.
"
},
"description": {
"type": "string",
"example": "Game description",
"description": "Описание товара."
},
"image_url": {
"type": "string",
"example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"description": "URL-адрес изображения."
},
"unit_items": {
"$ref": "#/components/schemas/unit_items"
}
}
},
"quantity": {
"type": "number",
"description": "Количество товаров.",
"default": 1
}
}
},
"Promotions_discounted_items": {
"type": [
"array",
"null"
],
"description": "Список товаров, на которые действует скидка по промокоду.",
"items": {
"description": "Скидка на определенные товары в корзине.",
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "Артикул товара.",
"default": "elven_shield"
},
"discount": {
"type": "object",
"nullable": false,
"properties": {
"percent": {
"$ref": "#/components/schemas/Promotions_cart_item_discount"
}
},
"required": [
"percent"
]
}
},
"required": [
"sku",
"discount"
],
"minItems": 1
}
},
"Promo_code_rewards": {
"type": "object",
"properties": {
"bonus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Promotions_200-promo-code-bonus-reward"
}
},
"discount": {
"$ref": "#/components/schemas/Promotions_200-coupon-discount-reward"
},
"discounted_items": {
"$ref": "#/components/schemas/Promotions_discounted_items"
},
"is_selectable": {
"type": "boolean",
"description": "Если `true`, пользователь должен выбрать бонус перед погашением промокода."
}
}
},
"admin-attribute-external_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9-_]+$",
"example": "attribute_1",
"description": "Уникальный ID атрибута. `external_id` может содержать только строчные и заглавные латинские буквы, цифры, тире и подчеркивания."
},
"value-external_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[-_.\\d\\w]+$",
"example": "attribute_value",
"description": "Уникальный ID значения атрибута. `external_id` может содержать только строчные латинские буквы, цифры, тире и подчеркивания."
},
"client-attributes": {
"type": "array",
"description": "Список атрибутов и их значений, соответствующих товару. Может использоваться для фильтрации каталога.",
"example": {
"value": {
"external_id": "genre",
"name": "Жанр",
"values": [
{
"external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Casual"
},
{
"external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7",
"value": "Strategy"
},
{
"external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8",
"value": "Mobile"
}
]
}
},
"default": [],
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"type": "string",
"description": "Название атрибута.",
"example": "Genre"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
},
"value": {
"type": "string",
"description": "Значение атрибута.",
"example": "Strategy"
}
}
}
}
}
}
},
"Promotions_promocode_total_limit_state": {
"type": [
"object",
"null"
],
"description": "Лимиты для каждого уникального промокода.",
"properties": {
"available": {
"type": "integer",
"description": "Оставшееся количество использований промокода.",
"example": 3
},
"reserved": {
"type": "integer",
"description": "Зарезервированное количество промокодов.",
"example": 3
},
"used": {
"type": "integer",
"description": "Сколько раз использовался промокод.",
"example": 5
}
}
},
"price_conditions_items": {
"description": "Each object describes a rule the price should be.",
"type": "object",
"properties": {
"operator": {
"type": "string",
"description": "Оператор сравнения для задания ценового диапазона применения акции.\n\nPossible values:\n- `ge` — Greater or equal\n- `gt` — Greater than\n- `le` — Less or equal\n- `lt` — Less than\n- `eq` — Equals\n- `ne` — Not equals",
"enum": [
"ge",
"gt",
"le",
"lt",
"eq",
"ne"
]
},
"value": {
"type": "string",
"description": "Значение для определения ценового диапазона применения акции.",
"pattern": "^\\d+(\\.\\d{1,4})?$"
}
},
"required": [
"operator",
"value"
]
},
"price_conditions_promocode": {
"type": [
"array",
"null"
],
"description": "Массив объектов с условиями, задающими ценовой диапазон применения акции для отдельных товаров в корзине.
\nСтоимость каждого товара в корзине пользователя сравнивается с заданным в условии ценовым диапазоном. [Бонусы](/ru/api/shop-builder/operation/create-promo-code/#!path=bonus&t=request) и [скидки](/ru/api/shop-builder/operation/create-promo-code/#!path=discount&t=request) применяются только к тем товарам в корзине, цена которых удовлетворяет условию.
\nЕсли вы передаете этот массив, в массиве [discounted_items](/ru/api/shop-builder/operation/create-promo-code/#!path=discounted_items&t=request) передайте значение `null`.",
"items": {
"$ref": "#/components/schemas/price_conditions_items"
}
},
"item_price_conditions_promocode": {
"type": [
"array",
"null"
],
"description": "Массив объектов с условиями, задающими ценовой диапазон применения акции для отдельных товаров в корзине.
\nСтоимость каждого товара в корзине пользователя сравнивается с заданным в условии ценовым диапазоном. [Бонусы](/ru/api/shop-builder/operation/create-promo-code/#!path=bonus&t=request) и [скидки](/ru/api/shop-builder/operation/create-promo-code/#!path=discount&t=request) применяются только к тем товарам в корзине, цена которых удовлетворяет условию.
\nЕсли вы передаете этот массив, в массиве [discounted_items](/ru/api/shop-builder/operation/create-promo-code/#!path=discounted_items&t=request) передайте значение `null`.",
"items": {
"$ref": "#/components/schemas/price_conditions_items"
}
},
"excluded_promotions": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12,
789
],
"description": "Список акций, которые исключаются при применении этой акции.
Example: `[12, 789]`"
},
"Promotions_200-get-promocode-promotion-model": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/Promotions_coupon-external_id"
},
"promotion_periods": {
"$ref": "#/components/schemas/promotion_periods"
},
"name": {
"$ref": "#/components/schemas/Promotions_coupon_name"
},
"bonus": {
"$ref": "#/components/schemas/Promotions_coupon_bonus"
},
"is_enabled": {
"$ref": "#/components/schemas/Promotions_coupon-is_enabled"
},
"redeem_total_limit": {
"$ref": "#/components/schemas/Promotions_coupon-redeem_total_limit"
},
"redeem_user_limit": {
"$ref": "#/components/schemas/Promotions_coupon-redeem_user_limit"
},
"redeem_code_limit": {
"$ref": "#/components/schemas/Promotions_redeem_code_limit"
},
"discount": {
"type": [
"object",
"null"
],
"properties": {
"percent": {
"$ref": "#/components/schemas/Promotions_promotion_discount_percent"
}
},
"example": {
"discount": {
"percent": "10.99"
}
}
},
"discounted_items": {
"$ref": "#/components/schemas/Promotions_discounted_items"
},
"total_limit_state": {
"$ref": "#/components/schemas/Promotions_promocode_total_limit_state"
},
"attribute_conditions": {
"$ref": "#/components/schemas/promotion_user-attribute_conditions_model-get"
},
"price_conditions": {
"$ref": "#/components/schemas/price_conditions_promocode"
},
"item_price_conditions": {
"$ref": "#/components/schemas/item_price_conditions_promocode"
},
"excluded_promotions": {
"$ref": "#/components/schemas/excluded_promotions"
}
}
},
"Promotions_is_enabled": {
"type": "boolean",
"example": true,
"description": "Активирована ли акция."
},
"price_conditions_discount": {
"type": [
"array",
"null"
],
"description": "Массив объектов с условиями, задающими ценовой диапазон применения акции.
Акция применяется только к товарам, цена которых удовлетворяет всем условиям в массиве. Если вы передаете этот массив, в объекте [items](/ru/api/shop-builder/operation/create-item-promotion/#!path=items&t=request) передайте значение `null`.",
"items": {
"$ref": "#/components/schemas/price_conditions_items"
}
},
"Promotions_promotion_limits": {
"type": "object",
"description": "Ограничения акции.",
"properties": {
"per_user": {
"type": [
"integer",
"null"
],
"description": "Ограничение количества использований акций отдельным пользователем."
},
"recurrent_schedule": {
"$ref": "#/components/schemas/promotion_recurrent_schedule_response"
}
}
},
"price_conditions_bonus": {
"type": [
"array",
"null"
],
"description": "Массив объектов с условиями, задающими ценовой диапазон применения акции.
Акция применяется только к товарам, цена которых удовлетворяет всем условиям в массиве. Если вы передаете этот массив, в объекте [condition](/ru/api/shop-builder/operation/create-bonus-promotion/#!path=condition&t=request) передайте значение `null`.",
"items": {
"$ref": "#/components/schemas/price_conditions_items"
}
},
"Promotions_200-get-bonus-promotion-model": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID акции. Уникальный идентификатор акции в рамках проекта."
},
"promotion_periods": {
"$ref": "#/components/schemas/promotion_periods"
},
"name": {
"type": "object",
"description": "Название акции. Данный параметр должен содержать пары ключ/значение,\nгде ключ — это локаль в формате \"^[a-z]{2}-[A-Z]{2}$\", значение — строка.",
"additionalProperties": {
"type": "string"
},
"example": {
"en-US": "Summer season bonus",
"de-DE": "Sommersaison Bonus"
}
},
"is_enabled": {
"type": "boolean",
"default": true
},
"condition": {
"type": [
"array",
"null"
],
"description": "Набор товаров, которые необходимо включить в покупку для применения акции. Если этот параметр равен `null`, акция будет применена к любым покупкам в рамках проекта.",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "Артикул товара.",
"default": "elven_sword"
}
}
}
},
"bonus": {
"type": [
"array",
"null"
],
"items": {
"description": "Список товаров, которые будут добавлены в покупку пользователя в качестве бонуса.",
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "Артикул товара.",
"default": "elven_shield"
},
"quantity": {
"type": "number",
"description": "Количество товаров.",
"default": 1
}
}
}
},
"attribute_conditions": {
"$ref": "#/components/schemas/promotion_user-attribute_conditions_model-get"
},
"limits": {
"$ref": "#/components/schemas/Promotions_promotion_limits_response"
},
"excluded_promotions": {
"$ref": "#/components/schemas/excluded_promotions"
},
"price_conditions": {
"$ref": "#/components/schemas/price_conditions_bonus"
}
}
},
"Coupon_rewards": {
"type": "object",
"properties": {
"bonus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Promotions_200-coupon-bonus-reward"
}
},
"is_selectable": {
"type": "boolean",
"description": "Если `true`, то пользователь должен выбрать бонус перед погашением купона."
}
}
},
"Promotions_discounted_items_verify": {
"type": [
"array",
"null"
],
"description": "Список товаров, на которые действует скидка по промокоду.",
"items": {
"description": "Скидка на определенные товары.",
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "game_01",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"name": {
"type": "string",
"example": "Game name",
"description": "Название товара."
},
"type": {
"type": "string",
"example": "unit",
"description": "Тип товара. Возможные значения:virtual_good — виртуальные товары;virtual_currency — виртуальная валюта;bundle — бандл;unit — пакет игровых ключей.
"
},
"description": {
"type": "string",
"example": "Game description",
"description": "Описание товара."
},
"image_url": {
"type": "string",
"example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"description": "URL-адрес изображения."
},
"unit_items": {
"$ref": "#/components/schemas/unit_items"
},
"discount": {
"type": "object",
"nullable": false,
"properties": {
"percent": {
"$ref": "#/components/schemas/Promotions_cart_item_discount"
}
}
}
}
}
},
"Promo_code_rewards_verify": {
"type": "object",
"properties": {
"bonus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Promotions_200-promo-code-bonus-reward"
}
},
"discount": {
"$ref": "#/components/schemas/Promotions_200-coupon-discount-reward"
},
"discounted_items": {
"$ref": "#/components/schemas/Promotions_discounted_items_verify"
},
"is_selectable": {
"type": "boolean",
"description": "Если `true`, пользователь должен выбрать бонус перед погашением промокода."
}
}
},
"sku": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9_\\-–.]*$",
"example": "booster_mega_1",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"Promotions_unique_catalog_offer_items": {
"type": "array",
"description": "Список артикулов товаров, которые доступны после использования уникального предложения по каталогу.",
"items": {
"$ref": "#/components/schemas/sku"
}
},
"Promotions_200-get-unique-catalog-offer-promotion-model": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/Promotions_coupon-external_id"
},
"promotion_periods": {
"$ref": "#/components/schemas/promotion_periods"
},
"name": {
"$ref": "#/components/schemas/Promotions_coupon_name"
},
"items": {
"$ref": "#/components/schemas/Promotions_unique_catalog_offer_items"
},
"is_enabled": {
"$ref": "#/components/schemas/Promotions_coupon-is_enabled"
},
"redeem_total_limit": {
"$ref": "#/components/schemas/Promotions_coupon-redeem_total_limit"
},
"redeem_user_limit": {
"$ref": "#/components/schemas/Promotions_coupon-redeem_user_limit"
},
"redeem_code_limit": {
"$ref": "#/components/schemas/Promotions_redeem_code_limit"
},
"total_limit_state": {
"$ref": "#/components/schemas/Promotions_coupon_total_limit_state"
}
}
},
"Promotions_coupon_date_start": {
"type": [
"string",
"null"
],
"format": "date-time",
"default": "2020-04-15T18:16:00+05:00",
"description": "Дата, когда начнется ваша акция."
},
"Promotions_coupon_date_end": {
"type": [
"string",
"null"
],
"format": "date-time",
"default": "2020-04-15T18:16:00+05:00",
"description": "Дата, когда ваша акция будет завершена. Может быть `null`. Если `date_end` равно `null`, акция будет неограниченна по времени."
},
"User-limit-promo-code": {
"type": "object",
"properties": {
"per_user": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"example": 10,
"description": "Максимальное количество использований промокода для пользователя."
},
"available": {
"type": "integer",
"example": 9,
"description": "Оставшееся количество использований промокода пользователем."
}
}
}
}
},
"User-limit-coupon": {
"type": "object",
"properties": {
"per_user": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"example": 10,
"description": "Максимальное количество использований купона для пользователя."
},
"available": {
"type": "integer",
"example": 9,
"description": "Оставшееся количество использований купона пользователем."
}
}
}
}
},
"Code-limit-promo-code": {
"type": "object",
"properties": {
"code": {
"$ref": "#/components/schemas/Promotions_coupon_code"
},
"per_code": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Максимальное количество использований промокода."
},
"available": {
"type": "integer",
"description": "Оставшееся количество использований промокода."
},
"used": {
"type": "integer",
"description": "Сколько раз использовался промокод."
},
"reserved": {
"type": "integer",
"description": "Сколько раз резервировался промокод."
}
}
}
}
},
"personalized-catalog_user-attribute_conditions_model-get": {
"allOf": [
{
"$ref": "#/components/schemas/user-attribute_conditions_model-get"
},
{
"description": "Условия для проверки атрибутов пользователя.\nОпределяют доступность товаров в каталоге на основе соответствия атрибутов пользователя всем указанным условиям."
}
]
},
"user-attribute_personalized-catalog": {
"type": "object",
"properties": {
"rule_id": {
"type": "number",
"description": "ID правила."
},
"name": {
"type": "string",
"description": "Читаемое название правила. Используется для отображения правила в Личном кабинете."
},
"is_enabled": {
"type": "boolean",
"description": "Включено ли данное правило."
},
"is_satisfied_for_unauth": {
"type": "boolean",
"description": "Отображается ли товар неавторизованным пользователям. Если `true`, товар отображается неавторизованным пользователям независимо от правил отображения каталога. `false` по умолчанию."
},
"attribute_conditions": {
"$ref": "#/components/schemas/personalized-catalog_user-attribute_conditions_model-get"
},
"items": {
"type": "array",
"items": {
"type": "object",
"description": "Товары, которые видит пользователь, если переданные им значения атрибутов товаров соответствуют условиям.",
"properties": {
"item_id": {
"type": "number",
"description": "ID предмета (артикул)."
},
"sku": {
"type": "string",
"description": "Артикул товара."
},
"name": {
"type": "string",
"description": "Название товара."
},
"type": {
"type": "string",
"description": "Тип товара.",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"physical_good",
"unit"
]
},
"bundle_type": {
"type": "string",
"description": "Тип бандла. Возвращается, если тип элемента является бандлом.",
"enum": [
"standard",
"virtual_currency_package"
]
}
}
}
}
},
"required": [
"rule_id",
"name",
"is_enabled",
"attribute_conditions",
"items"
]
},
"personalized-catalog_user-attribute_conditions_model-post": {
"allOf": [
{
"$ref": "#/components/schemas/user-attribute_conditions_model-post"
},
{
"description": "Условия для проверки атрибутов пользователя.\nОпределяют доступность товаров в каталоге на основе соответствия атрибутов пользователя всем указанным условиям."
}
]
},
"user-attribute_personalized-catalog-body-required": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Читаемое название правила. Используется для отображения правила в Личном кабинете.",
"minLength": 1,
"maxLength": 255,
"pattern": "^\\S"
},
"is_enabled": {
"type": "boolean",
"description": "Включено ли данное правило."
},
"is_satisfied_for_unauth": {
"type": "boolean",
"description": "Отображается ли товар неавторизованным пользователям. Если `true`, товар отображается неавторизованным пользователям независимо от правил отображения каталога. `false` по умолчанию."
},
"attribute_conditions": {
"$ref": "#/components/schemas/personalized-catalog_user-attribute_conditions_model-post"
},
"items": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": {
"oneOf": [
{
"type": "object",
"description": "Товары, которые видит пользователь, если переданные им значения атрибутов товаров соответствуют условиям.",
"properties": {
"item_id": {
"type": "number",
"description": "ID предмета (артикул)."
}
},
"required": [
"item_id"
]
},
{
"type": "object",
"description": "Товары, которые видит пользователь, если переданные им значения атрибутов товаров соответствуют условиям.",
"properties": {
"sku": {
"type": "string",
"description": "Артикул товара."
}
},
"required": [
"sku"
]
}
]
}
}
},
"required": [
"name",
"is_enabled",
"attribute_conditions",
"items"
]
},
"422-invalid-request": {
"type": "object",
"properties": {
"statusCode": {
"type": "number",
"description": "Код статуса ответа.",
"example": 422
},
"errorCode": {
"type": "number",
"description": "Код ошибки.",
"example": 1102
},
"errorMessage": {
"type": "string",
"description": "Удобочитаемое сообщение об ошибке.",
"example": "[0401-1102]: Unprocessable Entity. The property `external_id` is required"
},
"transactionId": {
"type": "string",
"description": "Уникальный ID запроса.",
"example": "da145238620011eb8e24fe6913ff226a"
}
}
},
"user-attribute_personalized-catalog_all": {
"type": "object",
"properties": {
"rule_id": {
"type": "number",
"description": "ID правила."
},
"name": {
"type": "string",
"description": "Читаемое название правила. Используется для отображения правила в Личном кабинете."
},
"is_enabled": {
"type": "boolean",
"description": "Включено ли данное правило."
},
"is_satisfied_for_unauth": {
"type": "boolean",
"description": "Отображается ли товар неавторизованным пользователям. Если `true`, товар отображается неавторизованным пользователям независимо от правил отображения каталога. `false` по умолчанию."
}
},
"required": [
"rule_id",
"name",
"is_enabled"
]
},
"user-attribute_personalized-catalog-body": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Читаемое название правила. Используется для отображения правила в Личном кабинете.",
"minLength": 1,
"maxLength": 255,
"pattern": "^\\S"
},
"is_enabled": {
"type": "boolean",
"description": "Включено ли данное правило."
},
"is_satisfied_for_unauth": {
"type": "boolean",
"description": "Отображается ли товар неавторизованным пользователям. Если `true`, товар отображается неавторизованным пользователям независимо от правил отображения каталога. `false` по умолчанию."
},
"attribute_conditions": {
"$ref": "#/components/schemas/personalized-catalog_user-attribute_conditions_model-post"
},
"items": {
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": {
"oneOf": [
{
"type": "object",
"description": "Товары, которые видит пользователь, если переданные им значения атрибутов товаров соответствуют условиям.",
"properties": {
"item_id": {
"type": "number",
"description": "ID предмета (артикул)."
}
},
"required": [
"item_id"
]
},
{
"type": "object",
"description": "Товары, которые видит пользователь, если переданные им значения атрибутов товаров соответствуют условиям.",
"properties": {
"sku": {
"type": "string",
"description": "Артикул товара."
}
},
"required": [
"sku"
]
}
]
}
}
}
},
"User-limit_user-external-id": {
"description": "External ID пользователя.",
"type": "string",
"minLength": 1,
"pattern": "^\\S+$"
},
"User-limit_user": {
"type": "object",
"properties": {
"user_external_id": {
"$ref": "#/components/schemas/User-limit_user-external-id"
}
},
"required": [
"user_external_id"
]
},
"User-limit_user_flexible": {
"type": [
"object",
"null"
],
"properties": {
"user_external_id": {
"$ref": "#/components/schemas/User-limit_user-external-id"
}
}
},
"User-limit-promotion": {
"type": "object",
"properties": {
"per_user": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"example": 10,
"description": "Максимальное количество раз, которое пользователь может использовать акцию."
},
"available": {
"type": "integer",
"example": 9,
"description": "Оставшееся количество раз, когда пользователь может воспользоваться акцией."
}
}
}
}
},
"User-limit_available_flexible": {
"type": "integer",
"minimum": 0,
"description": "Оставшееся количество товаров для продажи или доступных акций для пользователя в пределах установленных ограничений."
},
"User-limit_available": {
"type": "integer",
"minimum": 1,
"description": "Оставшееся количество товаров для продажи или доступных акций для пользователя в пределах установленных ограничений."
},
"two-letter-locale": {
"type": [
"object",
"null"
],
"description": "Двухбуквенные строчные языковые коды.",
"title": "two-letter",
"properties": {
"en": {
"type": [
"string",
"null"
],
"description": "Английский"
},
"ar": {
"type": [
"string",
"null"
],
"description": "Арабский"
},
"bg": {
"type": [
"string",
"null"
],
"description": "Болгарский"
},
"cn": {
"type": [
"string",
"null"
],
"description": "Китайский упрощенный"
},
"cs": {
"type": [
"string",
"null"
],
"description": "Чешский"
},
"de": {
"type": [
"string",
"null"
],
"description": "Немецкий"
},
"es": {
"type": [
"string",
"null"
],
"description": "Испанский"
},
"fr": {
"type": [
"string",
"null"
],
"description": "Французский"
},
"he": {
"type": [
"string",
"null"
],
"description": "Иврит"
},
"it": {
"type": [
"string",
"null"
],
"description": "Итальянский"
},
"ja": {
"type": [
"string",
"null"
],
"description": "Японский"
},
"ko": {
"type": [
"string",
"null"
],
"description": "Корейский"
},
"pl": {
"type": [
"string",
"null"
],
"description": "Польский"
},
"pt": {
"type": [
"string",
"null"
],
"description": "Португальский"
},
"ro": {
"type": [
"string",
"null"
],
"description": "Румынский"
},
"ru": {
"type": [
"string",
"null"
],
"description": "Русский"
},
"th": {
"type": [
"string",
"null"
],
"description": "Тайский"
},
"tr": {
"type": [
"string",
"null"
],
"description": "Турецкий"
},
"tw": {
"type": [
"string",
"null"
],
"description": "Китайский традиционный"
},
"vi": {
"type": [
"string",
"null"
],
"description": "Вьетнамский"
},
"km": {
"type": [
"string",
"null"
],
"description": "Кхмерский"
},
"id": {
"type": [
"string",
"null"
],
"description": "Индонезийский"
},
"lo": {
"type": [
"string",
"null"
],
"description": "Лаосский"
},
"my": {
"type": [
"string",
"null"
],
"description": "Бирманский"
},
"ph": {
"type": [
"string",
"null"
],
"description": "Филиппинский"
},
"ne": {
"type": [
"string",
"null"
],
"description": "Непальский"
}
}
},
"five-letter-locale": {
"type": [
"object",
"null"
],
"description": "Пятисимвольные коды локали.",
"title": "five-letter",
"properties": {
"en-US": {
"type": [
"string",
"null"
],
"description": "Английский"
},
"ar-AE": {
"type": [
"string",
"null"
],
"description": "Арабский"
},
"bg-BG": {
"type": [
"string",
"null"
],
"description": "Болгарский"
},
"zh-CN": {
"type": [
"string",
"null"
],
"description": "Китайский упрощенный"
},
"cs-CZ": {
"type": [
"string",
"null"
],
"description": "Чешский"
},
"de-DE": {
"type": [
"string",
"null"
],
"description": "Немецкий"
},
"es-ES": {
"type": [
"string",
"null"
],
"description": "Испанский"
},
"fr-FR": {
"type": [
"string",
"null"
],
"description": "Французский"
},
"he-IL": {
"type": [
"string",
"null"
],
"description": "Иврит"
},
"it-IT": {
"type": [
"string",
"null"
],
"description": "Итальянский"
},
"ja-JP": {
"type": [
"string",
"null"
],
"description": "Японский"
},
"ko-KR": {
"type": [
"string",
"null"
],
"description": "Корейский"
},
"pl-PL": {
"type": [
"string",
"null"
],
"description": "Польский"
},
"pt-BR": {
"type": [
"string",
"null"
],
"description": "Португальский"
},
"ro-RO": {
"type": [
"string",
"null"
],
"description": "Румынский"
},
"ru-RU": {
"type": [
"string",
"null"
],
"description": "Русский"
},
"th-TH": {
"type": [
"string",
"null"
],
"description": "Тайский"
},
"tr-TR": {
"type": [
"string",
"null"
],
"description": "Турецкий"
},
"zh-TW": {
"type": [
"string",
"null"
],
"description": "Китайский традиционный"
},
"vi-VN": {
"type": [
"string",
"null"
],
"description": "Вьетнамский"
},
"km-KH": {
"type": [
"string",
"null"
],
"description": "Кхмерский"
},
"id-ID": {
"type": [
"string",
"null"
],
"description": "Индонезийский"
},
"lo-LA": {
"type": [
"string",
"null"
],
"description": "Лаосский"
},
"my-MM": {
"type": [
"string",
"null"
],
"description": "Бирманский"
},
"ph-PH": {
"type": [
"string",
"null"
],
"description": "Филиппинский"
},
"ne-NP": {
"type": [
"string",
"null"
],
"description": "Непальский"
}
}
},
"name-localization-object": {
"type": [
"object",
"null"
],
"description": "Объект с локализованными названиями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, `en`) или код языка из пяти символов (например, `en-US`). Оба формата допустимы при отправке запроса, но в ответе всегда используется двухбуквенный код языка. Если для одного языка указаны оба варианта (например, `en` и `en-US`), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в [документации](/ru/doc/shop-builder/references/supported-languages/).",
"anyOf": [
{
"$ref": "#/components/schemas/two-letter-locale"
},
{
"$ref": "#/components/schemas/five-letter-locale"
}
]
},
"description-localization-object": {
"type": [
"object",
"null"
],
"description": "Объект с локализованными описаниями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, `en`) или код локали из пяти символов (например, `en-US`). Оба формата допустимы при отправке запроса, но в ответе всегда используется код из двух символов. Если для одного языка указаны оба варианта (например, `en` и `en-US`), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в [документации](/ru/doc/shop-builder/references/supported-languages/).",
"anyOf": [
{
"$ref": "#/components/schemas/two-letter-locale"
},
{
"$ref": "#/components/schemas/five-letter-locale"
}
]
},
"long-description-localization-object": {
"type": [
"object",
"null"
],
"description": "Объект с локализованными длинными описаниями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, `en`) или код локали из пяти символов (например, `en-US`). Оба формата допустимы при отправке запроса, но в ответе всегда используется код из двух символов. Если для одного языка указаны оба варианта (например, `en` и `en-US`), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в [документации](/ru/doc/shop-builder/references/supported-languages/).",
"anyOf": [
{
"$ref": "#/components/schemas/two-letter-locale"
},
{
"$ref": "#/components/schemas/five-letter-locale"
}
]
},
"Value-points-item-model": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9_\\-–.]*$",
"example": "booster_mega_1",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"media_list": {
"type": "array",
"example": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"description": "Дополнительные ассеты предмета, такие как скриншоты, видео игрового процесса и так далее.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"image",
"video"
],
"example": "image",
"description": "Тип медиа: `image`/`video`."
},
"url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg",
"description": "Ссылка на файл."
}
}
}
},
"type": {
"type": "string",
"description": "Тип товара."
},
"image_url": {
"type": "string"
},
"is_enabled": {
"type": "boolean"
},
"order": {
"type": "integer",
"example": 1,
"description": "Определяет порядок расположения."
},
"is_clan": {
"$ref": "#/components/schemas/is_clan"
}
}
},
"is_enabled": {
"type": "boolean",
"example": true
},
"media_list": {
"type": "array",
"example": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"description": "Дополнительные ассеты предмета, такие как скриншоты, видео игрового процесса и так далее.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"image",
"video"
],
"example": "image",
"description": "Тип медиа: `image`/`video`."
},
"url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg",
"description": "Ссылка на файл."
}
}
}
},
"order": {
"type": "integer",
"example": 1,
"description": "Определяет порядок расположения."
},
"admin_value_points-create": {
"properties": {
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Common_admin-image_url"
},
"is_enabled": {
"$ref": "#/components/schemas/is_enabled"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"media_list": {
"$ref": "#/components/schemas/media_list"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"order": {
"$ref": "#/components/schemas/order"
},
"sku": {
"$ref": "#/components/schemas/sku"
},
"is_clan": {
"$ref": "#/components/schemas/is_clan"
}
},
"type": "object",
"required": [
"sku",
"name"
]
},
"422-rc-vp-invalid-request": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"Value-point-item-model": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9_\\-–.]*$",
"example": "booster_mega_1",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"media_list": {
"type": "array",
"example": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"description": "Дополнительные ассеты предмета, такие как скриншоты, видео игрового процесса и так далее.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"image",
"video"
],
"example": "image",
"description": "Тип медиа: `image`/`video`."
},
"url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg",
"description": "Ссылка на файл."
}
}
}
},
"type": {
"type": "string",
"description": "Тип товара."
},
"image_url": {
"type": "string"
},
"is_enabled": {
"type": "boolean"
},
"order": {
"type": "integer",
"example": 1,
"description": "Определяет порядок расположения."
},
"can_delete": {
"type": "boolean",
"description": "Может ли призовой балл быть удален. Если `false` вы не можете удалить призовой балл, так как есть одна или несколько цепочек наград, в которой он используется. Чтобы удалить призовой балл, сначала [удалите](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-delete-reward-chain/) все все цепочки наград с ним.\n\nЕсли `true`, призовой балл не используется ни в одной цепочке наград и вы можете [удалить](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-delete-value-point/) его."
},
"is_clan": {
"$ref": "#/components/schemas/is_clan"
}
}
},
"admin-item-value-point-reward": {
"type": "object",
"properties": {
"item_id": {
"$ref": "#/components/schemas/item_id"
},
"sku": {
"$ref": "#/components/schemas/sku"
},
"amount": {
"type": "integer",
"description": "Количество призовых баллов."
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Common_admin-image_url"
}
}
},
"item-value-point-reward-set": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/sku"
},
"amount": {
"type": "integer",
"description": "Количество призовых баллов."
}
},
"required": [
"sku",
"amount"
]
}
},
"item-value-point-reward-set-for-patch": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/sku"
},
"amount": {
"type": "integer",
"description": "Количество призовых баллов.",
"minimum": 0
}
},
"required": [
"sku",
"amount"
],
"maxItems": 100
}
},
"date_start": {
"type": "string",
"format": "date-time",
"example": "2020-04-15T18:16:00+05:00",
"description": "Дата, когда начнет действовать ваша цепочка наград."
},
"date_end": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2020-04-15T18:16:00+05:00",
"description": "Дата, когда закончится действие акции с цепочкой наград. Может быть `null`. Если `date_end` равна `null`, то цепочка наград не будет ограничена по времени."
},
"clan_type": {
"type": [
"string",
"null"
],
"description": "Тип клана.",
"enum": [
"clan",
"guild",
"faction",
"community",
"team",
"squad",
"alliance",
"association",
"coalition",
"union",
"group",
"civilizations",
"dynasty",
"order",
"league",
"brotherhood",
"kingdom",
"organization",
"house",
"empire",
"tribe",
"cartel",
null
]
},
"top_contributors": {
"type": [
"object",
"null"
],
"properties": {
"name": {
"type": "string",
"example": "Rocket",
"description": "ID пользователя, который отправляется в Xsolla в процессе авторизации, связывает пользователя с вашим проектом Xsolla Login и отображается в качестве никнейма. Если вы используете [авторизацию по ID пользователя](https://developers.xsolla.com/ru/solutions/web-shop/create-web-shop/set-up-authentication/?tabs=100-UserIDAuth&link=100-UserIDAuth), мы рекомендуем передать параметр name [в ответе на вебхук](https://developers.xsolla.com/ru/webhooks/operation/user-validation-in-webshop/). Этот параметр содержит имя пользователя, которое будет использоваться как никнейм."
},
"contributed_amount": {
"type": "integer",
"example": 100,
"description": "Количество призовых баллов, которые заработал пользователь."
}
}
},
"value-point-description": {
"type": [
"string",
"null"
],
"description": "Описание призовых баллов."
},
"value-point-long-description": {
"type": [
"string",
"null"
],
"description": "Развернутое описание призовых баллов."
},
"interval_type_weekly": {
"type": "string",
"description": "Частота регулярного сброса цепочки наград.",
"enum": [
"weekly"
]
},
"interval_type_monthly": {
"type": "string",
"description": "Частота регулярного сброса цепочки наград.",
"enum": [
"monthly"
]
},
"interval_type_hourly_rc": {
"type": "string",
"description": "Частота регулярного сброса цепочки наград.",
"enum": [
"hourly"
]
},
"reset_next_date": {
"type": "integer",
"description": "Расчетные дата и время, когда цепочка наград будет сброшена в следующий раз (Unix Timestamp).
Например, сброс цепочки наград осуществляется ежемесячно, начиная с 1 марта 2024 в 01:00 по часовому поясу Куала-Лумпура (GMT+8). Дата и время следующего сброса цепочки наград: 1 апреля 2024 в 01:00 по часовому поясу Куала-Лумпура (GMT+8), что соответствует 31 марта 2024 17:00 GMT+0 или `1711904400000` в формате Unix Timestamp.
Example: `1711904400000`"
},
"recurrent_schedule_client_side": {
"type": [
"object",
"null"
],
"description": "Период регулярного сброса цепочки наград.",
"properties": {
"interval_type": {
"oneOf": [
{
"title": "interval_type = weekly",
"$ref": "#/components/schemas/interval_type_weekly"
},
{
"title": "interval_type = monthly",
"$ref": "#/components/schemas/interval_type_monthly"
},
{
"title": "interval_type = hourly",
"$ref": "#/components/schemas/interval_type_hourly_rc"
}
]
},
"reset_next_date": {
"$ref": "#/components/schemas/reset_next_date"
}
}
},
"popup_header-two-letter-locale": {
"type": [
"object",
"null"
],
"description": "Объект с локализациями для описания всплывающей подсказки в цепочке наград для клана. Двухбуквенный [код языка в нижнем регистре](https://developers.xsolla.com/ru/doc/pay-station/features/localization/).",
"properties": {
"en": {
"type": [
"string",
"null"
],
"example": "How to unlock rewards"
},
"ar": {
"type": [
"string",
"null"
],
"example": null
},
"bg": {
"type": [
"string",
"null"
],
"example": null
},
"cn": {
"type": [
"string",
"null"
],
"example": null
},
"cs": {
"type": [
"string",
"null"
],
"example": null
},
"de": {
"type": [
"string",
"null"
],
"example": "Wie man Belohnungen freischaltet"
},
"es": {
"type": [
"string",
"null"
],
"example": "Cómo desbloquear recompensas"
},
"fr": {
"type": [
"string",
"null"
],
"example": "Comment débloquer des récompenses"
},
"he": {
"type": [
"string",
"null"
],
"example": null
},
"it": {
"type": [
"string",
"null"
],
"example": "Come sbloccare ricompense"
},
"ja": {
"type": [
"string",
"null"
],
"example": "報酬をアンロックする方法"
},
"ko": {
"type": [
"string",
"null"
],
"example": null
},
"pl": {
"type": [
"string",
"null"
],
"example": null
},
"pt": {
"type": [
"string",
"null"
],
"example": null
},
"ro": {
"type": [
"string",
"null"
],
"example": null
},
"ru": {
"type": [
"string",
"null"
],
"example": null
},
"th": {
"type": [
"string",
"null"
],
"example": null
},
"tr": {
"type": [
"string",
"null"
],
"example": null
},
"tw": {
"type": [
"string",
"null"
],
"example": null
},
"vi": {
"type": [
"string",
"null"
],
"example": null
}
}
},
"popup_instruction-two-letter-locale": {
"type": [
"object",
"null"
],
"description": "Объект с локализациями для описания всплывающей подсказки в цепочке наград для клана. Двухбуквенный [код языка в нижнем регистре](https://developers.xsolla.com/ru/doc/pay-station/features/localization/).",
"properties": {
"en": {
"type": [
"string",
"null"
],
"example": "You must be a clan member to get clan rewards. You join a clan when a clan member invites you to the clan, and you accept the invite. You can also create your own clan."
},
"ar": {
"type": [
"string",
"null"
],
"example": null
},
"bg": {
"type": [
"string",
"null"
],
"example": null
},
"cn": {
"type": [
"string",
"null"
],
"example": null
},
"cs": {
"type": [
"string",
"null"
],
"example": null
},
"de": {
"type": [
"string",
"null"
],
"example": "Du musst ein Clanmitglied sein, um Clananreize zu erhalten. Du trittst einem Clan bei, wenn ein Clanmitglied dich einlädt, und du die Einladung annimmst. Du kannst auch deinen eigenen Clan erstellen."
},
"es": {
"type": [
"string",
"null"
],
"example": "Debes ser miembro de un clan para obtener las recompensas del clan. Te unes a un clan cuando un miembro del clan te invita al clan y aceptas la invitación. También puedes crear tu propio clan."
},
"fr": {
"type": [
"string",
"null"
],
"example": "Vous devez être membre d'un clan pour obtenir les récompenses du clan. Vous rejoignez un clan lorsque qu'un membre du clan vous invite au clan et que vous acceptez l'invitation. Vous pouvez également créer votre propre clan."
},
"he": {
"type": [
"string",
"null"
],
"example": null
},
"it": {
"type": [
"string",
"null"
],
"example": "Devi essere un membro del clan per ottenere le ricompense del clan. Ti unisci a un clan quando un membro del clan ti invita al clan e accetti l'invito. Puoi anche creare il tuo clan."
},
"ja": {
"type": [
"string",
"null"
],
"example": "クランリワードを受け取るには、クランメンバーでなければなりません。 クランメンバーがあなたをクランに招待し、招待を受け入れると、クランに参加できます。 あなた自身のクランを作成することもできます。"
},
"ko": {
"type": [
"string",
"null"
],
"example": null
},
"pl": {
"type": [
"string",
"null"
],
"example": null
},
"pt": {
"type": [
"string",
"null"
],
"example": null
},
"ro": {
"type": [
"string",
"null"
],
"example": null
},
"ru": {
"type": [
"string",
"null"
],
"example": null
},
"th": {
"type": [
"string",
"null"
],
"example": null
},
"tr": {
"type": [
"string",
"null"
],
"example": null
},
"tw": {
"type": [
"string",
"null"
],
"example": null
},
"vi": {
"type": [
"string",
"null"
],
"example": null
}
}
},
"popup_image_url": {
"type": [
"string",
"null"
],
"example": "https://image.example.com",
"description": "Изображение для подсказки про цепочку наград для клана во всплывающем окне.",
"format": "uri"
},
"client-reward-chain-item-model": {
"type": "object",
"properties": {
"reward_chain_id": {
"type": "integer",
"example": 9,
"description": "ID цепочки наград."
},
"name": {
"type": "string",
"example": "Weekly quest",
"description": "Название цепочки наград."
},
"description": {
"type": [
"string",
"null"
],
"example": "Major weekly quest",
"description": "Описание цепочки наград."
},
"long_description": {
"type": [
"string",
"null"
],
"example": "You can get a lot of additional items just by shopping during the week",
"description": "Развернутое описание цепочки наград."
},
"image_url": {
"$ref": "#/components/schemas/image_url"
},
"order": {
"$ref": "#/components/schemas/order"
},
"date_start": {
"$ref": "#/components/schemas/date_start"
},
"date_end": {
"$ref": "#/components/schemas/date_end"
},
"clan_type": {
"$ref": "#/components/schemas/clan_type"
},
"top_contributors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/top_contributors"
}
},
"value_point": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/value-point-sku"
},
"name": {
"$ref": "#/components/schemas/value-point-name"
},
"image_url": {
"$ref": "#/components/schemas/Common_admin-image_url"
},
"description": {
"$ref": "#/components/schemas/value-point-description"
},
"long_description": {
"$ref": "#/components/schemas/value-point-long-description"
},
"amount": {
"$ref": "#/components/schemas/value-point-amount"
},
"is_clan": {
"$ref": "#/components/schemas/is_clan"
}
}
},
"steps": {
"type": "array",
"items": {
"type": "object",
"description": "Уровень цепочки наград.",
"properties": {
"step_id": {
"type": "integer",
"example": 10,
"description": "ID уровня."
},
"name": {
"type": "string",
"example": "Level 1",
"description": "Название уровня."
},
"is_claimed": {
"type": "boolean",
"example": false,
"description": "Получена ли награда за уровень."
},
"image_url": {
"$ref": "#/components/schemas/Common_admin-image_url"
},
"price": {
"type": "object",
"properties": {
"amount": {
"type": "integer",
"example": 100,
"description": "Количество призовых баллов, которое пользователь получит за прохождение уровня."
}
}
},
"reward": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/sku"
},
"name": {
"type": "string",
"example": "Super box",
"description": "Название товара."
},
"type": {
"type": "string",
"example": "bundle",
"description": "Тип товара."
},
"description": {
"type": "string",
"example": "Super box with items",
"description": "Описание товара."
},
"image_url": {
"$ref": "#/components/schemas/Common_admin-image_url"
},
"quantity": {
"type": "integer",
"example": 2,
"description": "Количество товаров."
}
}
}
}
}
}
},
"recurrent_schedule": {
"$ref": "#/components/schemas/recurrent_schedule_client_side"
},
"popup_header": {
"$ref": "#/components/schemas/popup_header-two-letter-locale"
},
"popup_instruction": {
"$ref": "#/components/schemas/popup_instruction-two-letter-locale"
},
"popup_image_url": {
"$ref": "#/components/schemas/popup_image_url"
}
}
},
"Pagination_has-more": {
"type": "boolean",
"example": true,
"description": "Используется как индикатор того, что остались еще страницы."
},
"reward_chain_id": {
"type": "integer",
"example": 9,
"description": "Уникальный ID цепочки наград."
},
"periods": {
"type": "array",
"nullable": false,
"description": "Периоды действия цепочки наград. Если указано больше одного периода, параметры `date_from` и `date_until` становятся обязательными.",
"items": {
"type": "object",
"properties": {
"date_from": {
"type": "string",
"format": "date-time",
"nullable": false,
"example": "2020-08-11T10:00:00+03:00",
"description": "Дата начала действия указанной цепочки наград."
},
"date_until": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2020-08-11T20:00:00+03:00",
"description": "Дата окончания действия указанной цепочки наград. Может быть `null`, только если указан один период действия."
}
},
"required": [
"date_from"
]
}
},
"day_of_week": {
"type": "integer",
"description": "День недели, когда осуществляется сброс цепочки наград, где `1` — понедельник и `7` — воскресенье.",
"minimum": 1,
"maximum": 7
},
"time": {
"type": "string",
"description": "Время, когда происходит сброс цепочки наград в желаемом часовом поясе (округление до часов).
Например, задано время сброса цепочки наград 01:00 для часового пояса Куала-Лумпура (GMT+8). Значение параметра `time` в этом случае `01:00:00+08:00`.",
"pattern": "((0[0-9]|1[0-9]|2[0-3]):00:00)(\\+|-)(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])",
"example": "01:00:00+08:00"
},
"displayable_reset_start_date": {
"description": "Дата и время первого сброса цепочки наград.
Например, дата и время первого сброса цепочки наград — 1 марта 2024 в 01:00 по часовому поясу Куала-Лумпура (GMT+8) или `2024-03-01T01:00:00+08:00` в формате ISO 8601.
Example: `2024-03-01T01:00:00+08:00`",
"type": "string",
"format": "date-time"
},
"displayable_reset_next_date": {
"description": "Расчетные дата и время, когда цепочка наград будет сброшена в следующий раз (ISO 8601).
Например, сброс цепочки наград осуществляется ежемесячно, начиная с 1 марта 2024 в 01:00 по часовому поясу Куала-Лумпура (GMT+8). Дата и время следующего сброса цепочки наград: 1 апреля 2024 в 01:00 по часовому поясу Куала-Лумпура (GMT+8), что соответствует значению `2024-04-01T01:00:00+08:00` в формате ISO 8601.
Example: `2024-04-01T01:00:00+08:00`",
"type": "string",
"format": "date-time"
},
"day_of_month": {
"type": "integer",
"description": "День месяца, когда происходит сброс цепочки наград. Если количество дней в месяце меньше, чем порядковый номер указанного дня, сброс цепочки наград происходит в последний день месяца.",
"minimum": 1,
"maximum": 31
},
"reward_chain_hours_interval": {
"type": "integer",
"description": "Интервал в часах, через который выполняется сброс цепочки наград.
Отсчет начинается от значения date_start. Например, если `date_start = \"2025-11-15T18:15:00+05:00\"` и `hours_interval = 2`, цепочка будет сбрасываться каждые 2 часа, начиная с `\"2025-11-15T20:15:00+05:00\"`.",
"minimum": 1,
"maximum": 10000
},
"admin_recurrent_schedule": {
"description": "Период регулярного сброса цепочки наград.",
"oneOf": [
{
"type": "object",
"title": "interval_type = weekly",
"description": "Еженедельный сброс цепочки наград.",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/interval_type_weekly"
},
"day_of_week": {
"$ref": "#/components/schemas/day_of_week"
},
"time": {
"$ref": "#/components/schemas/time"
},
"reset_next_date": {
"$ref": "#/components/schemas/reset_next_date"
},
"displayable_reset_start_date": {
"$ref": "#/components/schemas/displayable_reset_start_date"
},
"displayable_reset_next_date": {
"$ref": "#/components/schemas/displayable_reset_next_date"
}
}
},
{
"type": "object",
"title": "interval_type = monthly",
"description": "Ежемесячный сброс цепочки наград.",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/interval_type_monthly"
},
"day_of_month": {
"$ref": "#/components/schemas/day_of_month"
},
"time": {
"$ref": "#/components/schemas/time"
},
"reset_next_date": {
"$ref": "#/components/schemas/reset_next_date"
},
"displayable_reset_start_date": {
"$ref": "#/components/schemas/displayable_reset_start_date"
},
"displayable_reset_next_date": {
"$ref": "#/components/schemas/displayable_reset_next_date"
}
}
},
{
"type": "object",
"title": "interval_type = hourly",
"description": "Сброс цепочки наград, выполняемый через временной интервал, заданный в часах.",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/interval_type_hourly_rc"
},
"hours_interval": {
"$ref": "#/components/schemas/reward_chain_hours_interval"
},
"time": {
"$ref": "#/components/schemas/time"
},
"reset_next_date": {
"$ref": "#/components/schemas/reset_next_date"
},
"displayable_reset_start_date": {
"$ref": "#/components/schemas/displayable_reset_start_date"
},
"displayable_reset_next_date": {
"$ref": "#/components/schemas/displayable_reset_next_date"
}
}
},
{
"type": "null",
"title": "null"
}
]
},
"chain_user-attribute_conditions_model-get": {
"allOf": [
{
"$ref": "#/components/schemas/user-attribute_conditions_model-get"
},
{
"description": "Условия для проверки атрибутов пользователя. Определяют доступность цепочки на основе соответствия атрибутов пользователя всем указанным условиям."
}
]
},
"chain_is_always_visible": {
"description": "Отображается ли цепочка всем пользователям. Если `true`, цепочка всегда отображается, независимо от авторизации пользователя и его атрибутов.\n\nДля настройки персонализации вам необходимо передать значение `false`. Логика отображения цепочки будет следующей:\n * Если передано значение `false` и в массиве `attribute_conditions` заданы условия отображения, цепочка считается персонализированной и отображается только для авторизованных пользователей, атрибуты которых удовлетворяют заданным условиям.\n * Если передано значение `false` и массив `attribute_conditions` не передан или пустой, цепочка отображается неавторизованным пользователям и авторизованным пользователям, для которых не нашлось ни одной персонализированной цепочки.",
"type": "boolean",
"default": true,
"example": true
},
"is_reset_after_end": {
"description": "Нужно ли сбрасывать цепочку наград (призовые баллы и прогресс всех пользователей) после даты ее окончания:\n* Если `true`, цепочка наград будет сброшена после даты окончания.\n* Если `false`, цепочка наград не будет сброшена после даты окончания.\n\n
\n\nВнимание\nНе может быть
true, если:
\n
\n- В
recurrent_schedule задан период регулярного обновления. \n- В
periods.date_until передано null. \n
\n
",
"type": "boolean",
"default": false,
"example": false
},
"admin-get-reward-chain-item-basic-model": {
"type": "object",
"description": "Цепочка наград.",
"properties": {
"reward_chain_id": {
"$ref": "#/components/schemas/reward_chain_id"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"order": {
"$ref": "#/components/schemas/order"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/image_url"
},
"periods": {
"$ref": "#/components/schemas/periods"
},
"is_enabled": {
"$ref": "#/components/schemas/is_enabled"
},
"value_point": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/value-point-sku"
},
"name": {
"$ref": "#/components/schemas/value-point-name"
},
"type": {
"type": "string",
"example": "value_point"
},
"image_url": {
"$ref": "#/components/schemas/Common_admin-image_url"
},
"description": {
"$ref": "#/components/schemas/value-point-description"
},
"long_description": {
"$ref": "#/components/schemas/value-point-long-description"
},
"amount": {
"$ref": "#/components/schemas/value-point-amount"
},
"is_clan": {
"$ref": "#/components/schemas/is_clan"
},
"is_enabled": {
"$ref": "#/components/schemas/is_enabled"
},
"media_list": {
"$ref": "#/components/schemas/media_list"
},
"order": {
"$ref": "#/components/schemas/order"
}
}
},
"recurrent_schedule": {
"$ref": "#/components/schemas/admin_recurrent_schedule"
},
"attribute_conditions": {
"$ref": "#/components/schemas/chain_user-attribute_conditions_model-get"
},
"is_always_visible": {
"$ref": "#/components/schemas/chain_is_always_visible"
},
"is_reset_after_end": {
"$ref": "#/components/schemas/is_reset_after_end"
}
}
},
"admin-get-reward-chain-item-clan-basic-model": {
"allOf": [
{
"$ref": "#/components/schemas/admin-get-reward-chain-item-basic-model"
},
{
"type": "object",
"description": "Клановая цепочка наград.",
"properties": {
"value_point": {
"type": "object",
"description": "Призовой балл для цепочки наград клана.",
"properties": {
"sku": {
"$ref": "#/components/schemas/value-point-sku"
},
"name": {
"$ref": "#/components/schemas/value-point-name"
},
"type": {
"type": "string",
"example": "value_point"
},
"image_url": {
"$ref": "#/components/schemas/Common_admin-image_url"
},
"description": {
"$ref": "#/components/schemas/value-point-description"
},
"long_description": {
"$ref": "#/components/schemas/value-point-long-description"
},
"amount": {
"$ref": "#/components/schemas/value-point-amount"
},
"is_clan": {
"$ref": "#/components/schemas/is_clan"
},
"is_enabled": {
"$ref": "#/components/schemas/is_enabled"
},
"media_list": {
"$ref": "#/components/schemas/media_list"
},
"order": {
"$ref": "#/components/schemas/order"
}
},
"required": [
"sku"
]
},
"popup_header": {
"$ref": "#/components/schemas/popup_header-two-letter-locale"
},
"popup_instruction": {
"$ref": "#/components/schemas/popup_instruction-two-letter-locale"
},
"popup_image_url": {
"$ref": "#/components/schemas/popup_image_url"
},
"clan_type": {
"$ref": "#/components/schemas/clan_type"
}
}
}
]
},
"step_price_amount": {
"type": "integer",
"example": 100,
"description": "Цена уровня в призовых баллах."
},
"reward_step_price": {
"type": "object",
"properties": {
"amount": {
"$ref": "#/components/schemas/step_price_amount"
}
},
"required": [
"amount"
]
},
"reward_item_quantity": {
"type": "integer",
"example": 2,
"description": "Количество товаров."
},
"reward-chain-step-reward_user-attribute_conditions_model-post": {
"allOf": [
{
"$ref": "#/components/schemas/user-attribute_conditions_model-post"
},
{
"description": "Условия для проверки атрибутов пользователя.\nОпределяют доступность награды на шаге цепочки наград на основе соответствия атрибутов пользователя всем указанным условиям."
}
]
},
"create_reward_step": {
"type": "object",
"description": "Уровень цепочки наград.",
"properties": {
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"price": {
"$ref": "#/components/schemas/reward_step_price"
},
"image_url": {
"$ref": "#/components/schemas/image_url"
},
"reward": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/sku"
},
"quantity": {
"$ref": "#/components/schemas/reward_item_quantity"
},
"attribute_conditions": {
"$ref": "#/components/schemas/reward-chain-step-reward_user-attribute_conditions_model-post"
}
},
"required": [
"sku",
"quantity"
]
}
}
},
"required": [
"name",
"price",
"reward"
]
},
"recurrent_schedule_create_update": {
"description": "Период регулярного сброса цепочки наград.",
"oneOf": [
{
"type": "object",
"title": "interval_type = weekly",
"description": "Еженедельный сброс цепочки наград.",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/interval_type_weekly"
},
"day_of_week": {
"$ref": "#/components/schemas/day_of_week"
},
"time": {
"$ref": "#/components/schemas/time"
}
},
"required": [
"interval_type",
"time",
"day_of_week"
]
},
{
"type": "object",
"title": "interval_type = monthly",
"description": "Ежемесячный сброс цепочки наград.",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/interval_type_monthly"
},
"day_of_month": {
"$ref": "#/components/schemas/day_of_month"
},
"time": {
"$ref": "#/components/schemas/time"
}
},
"required": [
"interval_type",
"time",
"day_of_month"
]
},
{
"type": "object",
"title": "interval_type = hourly",
"description": "Сброс цепочки наград, выполняемый через временной интервал, заданный в часах.",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/interval_type_hourly_rc"
},
"hours_interval": {
"$ref": "#/components/schemas/reward_chain_hours_interval"
}
},
"required": [
"interval_type",
"hours_interval"
]
},
{
"type": "null",
"title": "null"
}
]
},
"chain_user-attribute_conditions_model-post": {
"allOf": [
{
"$ref": "#/components/schemas/user-attribute_conditions_model-post"
},
{
"description": "Условия для проверки атрибутов пользователя. Определяют доступность цепочки на основе соответствия атрибутов пользователя всем указанным условиям."
}
]
},
"create-reward-chain-model": {
"type": "object",
"description": "Цепочка наград.",
"properties": {
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/image_url"
},
"order": {
"$ref": "#/components/schemas/order"
},
"periods": {
"$ref": "#/components/schemas/periods"
},
"is_enabled": {
"$ref": "#/components/schemas/is_enabled"
},
"value_point": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/sku"
}
},
"required": [
"sku"
]
},
"steps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/create_reward_step"
}
},
"recurrent_schedule": {
"$ref": "#/components/schemas/recurrent_schedule_create_update"
},
"attribute_conditions": {
"$ref": "#/components/schemas/chain_user-attribute_conditions_model-post"
},
"is_always_visible": {
"$ref": "#/components/schemas/chain_is_always_visible"
},
"is_reset_after_end": {
"$ref": "#/components/schemas/is_reset_after_end"
}
},
"required": [
"name",
"value_point",
"periods",
"steps",
"is_enabled"
]
},
"create-clan-reward-chain-model": {
"allOf": [
{
"$ref": "#/components/schemas/create-reward-chain-model"
},
{
"type": "object",
"description": "Клановая цепочка наград.",
"properties": {
"value_point": {
"type": "object",
"description": "Призовой балл для цепочки наград клана.",
"properties": {
"sku": {
"$ref": "#/components/schemas/sku"
}
},
"required": [
"sku"
]
},
"popup_header": {
"$ref": "#/components/schemas/popup_header-two-letter-locale"
},
"popup_instruction": {
"$ref": "#/components/schemas/popup_instruction-two-letter-locale"
},
"popup_image_url": {
"$ref": "#/components/schemas/popup_image_url"
},
"clan_type": {
"$ref": "#/components/schemas/clan_type"
}
},
"required": [
"name",
"value_point",
"periods",
"steps",
"is_enabled",
"popup_header",
"popup_instruction"
]
}
]
},
"step_id": {
"type": [
"integer",
"null"
],
"example": 10,
"description": "Уникальный ID уровня."
},
"reward-chain-step-reward_user-attribute_conditions_model-get": {
"allOf": [
{
"$ref": "#/components/schemas/user-attribute_conditions_model-get"
},
{
"description": "Условия для проверки атрибутов пользователя.\nОпределяют доступность награды на шаге цепочки наград на основе соответствия атрибутов пользователя всем указанным условиям."
}
]
},
"reward_step_short": {
"type": "object",
"description": "Уровень цепочки наград.",
"properties": {
"step_id": {
"$ref": "#/components/schemas/step_id"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"price": {
"$ref": "#/components/schemas/reward_step_price"
},
"image_url": {
"$ref": "#/components/schemas/image_url"
},
"reward": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/sku"
},
"quantity": {
"$ref": "#/components/schemas/reward_item_quantity"
},
"attribute_conditions": {
"$ref": "#/components/schemas/reward-chain-step-reward_user-attribute_conditions_model-get"
}
}
}
}
}
},
"admin-get-reward-chain-item-full-model": {
"type": "object",
"description": "Цепочка наград.",
"properties": {
"reward_chain_id": {
"$ref": "#/components/schemas/reward_chain_id"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"order": {
"$ref": "#/components/schemas/order"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/image_url"
},
"periods": {
"$ref": "#/components/schemas/periods"
},
"is_enabled": {
"$ref": "#/components/schemas/is_enabled"
},
"value_point": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/sku"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"type": {
"type": "string"
},
"is_enabled": {
"$ref": "#/components/schemas/is_enabled"
},
"image_url": {
"$ref": "#/components/schemas/image_url"
},
"media_list": {
"$ref": "#/components/schemas/media_list"
},
"order": {
"$ref": "#/components/schemas/order"
},
"is_clan": {
"$ref": "#/components/schemas/is_clan"
}
}
},
"steps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/reward_step_short"
}
},
"recurrent_schedule": {
"$ref": "#/components/schemas/admin_recurrent_schedule"
},
"attribute_conditions": {
"$ref": "#/components/schemas/chain_user-attribute_conditions_model-get"
},
"is_always_visible": {
"$ref": "#/components/schemas/chain_is_always_visible"
},
"is_reset_after_end": {
"$ref": "#/components/schemas/is_reset_after_end"
}
}
},
"admin-get-reward-chain-item-clan-full-model": {
"allOf": [
{
"$ref": "#/components/schemas/admin-get-reward-chain-item-full-model"
},
{
"type": "object",
"description": "Клановая цепочка наград.",
"properties": {
"value_point": {
"type": "object",
"description": "Призовой балл для цепочки наград клана.",
"properties": {
"sku": {
"$ref": "#/components/schemas/sku"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"type": {
"type": "string"
},
"is_enabled": {
"$ref": "#/components/schemas/is_enabled"
},
"image_url": {
"$ref": "#/components/schemas/image_url"
},
"media_list": {
"$ref": "#/components/schemas/media_list"
},
"order": {
"$ref": "#/components/schemas/order"
},
"is_clan": {
"$ref": "#/components/schemas/is_clan"
}
},
"required": [
"sku"
]
},
"popup_header": {
"$ref": "#/components/schemas/popup_header-two-letter-locale"
},
"popup_instruction": {
"$ref": "#/components/schemas/popup_instruction-two-letter-locale"
},
"popup_image_url": {
"$ref": "#/components/schemas/popup_image_url"
},
"clan_type": {
"$ref": "#/components/schemas/clan_type"
},
"top_contributors": {
"$ref": "#/components/schemas/top_contributors"
}
}
}
]
},
"modify_reward_step": {
"type": "object",
"description": "Уровень цепочки наград.",
"properties": {
"step_id": {
"$ref": "#/components/schemas/step_id"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"price": {
"$ref": "#/components/schemas/reward_step_price"
},
"image_url": {
"$ref": "#/components/schemas/image_url"
},
"reward": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/sku"
},
"quantity": {
"$ref": "#/components/schemas/reward_item_quantity"
},
"attribute_conditions": {
"$ref": "#/components/schemas/reward-chain-step-reward_user-attribute_conditions_model-post"
}
},
"required": [
"sku",
"quantity"
]
}
}
},
"required": [
"name",
"price",
"reward",
"step_id"
]
},
"update-reward-chain-model": {
"type": "object",
"description": "Цепочка наград.",
"properties": {
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/image_url"
},
"order": {
"$ref": "#/components/schemas/order"
},
"periods": {
"$ref": "#/components/schemas/periods"
},
"is_enabled": {
"$ref": "#/components/schemas/is_enabled"
},
"steps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/modify_reward_step"
}
},
"recurrent_schedule": {
"$ref": "#/components/schemas/recurrent_schedule_create_update"
},
"attribute_conditions": {
"$ref": "#/components/schemas/chain_user-attribute_conditions_model-post"
},
"is_always_visible": {
"$ref": "#/components/schemas/chain_is_always_visible"
},
"is_reset_after_end": {
"$ref": "#/components/schemas/is_reset_after_end"
}
},
"required": [
"name",
"periods",
"steps",
"is_enabled"
]
},
"update-clan-reward-chain-model": {
"allOf": [
{
"$ref": "#/components/schemas/create-reward-chain-model"
},
{
"type": "object",
"description": "Клановая цепочка наград.",
"properties": {
"popup_header": {
"$ref": "#/components/schemas/popup_header-two-letter-locale"
},
"popup_instruction": {
"$ref": "#/components/schemas/popup_instruction-two-letter-locale"
},
"popup_image_url": {
"$ref": "#/components/schemas/popup_image_url"
},
"clan_type": {
"$ref": "#/components/schemas/clan_type"
}
},
"required": [
"name",
"periods",
"steps",
"is_enabled",
"popup_header",
"popup_instruction"
]
}
]
},
"daily_chain_type": {
"type": "string",
"enum": [
"calendar_hard",
"rolling_skippable",
"rolling_unskippable"
],
"description": "Тип ежедневной награды, который определяет, когда пользователи могут получать награды.\n\nВозможные значения:\n- `calendar_hard` — Разблокирует следующий шаг наград каждые 24 часа. Неполученные награды становятся недоступны, как только открывается награда за следующий шаг.\n- `rolling_skippable` — Разблокирует награду за следующий шаг каждые 24 часа, отсчет начинается со значения, указанного в параметре `date_start`. Прогресс последовательный: новая награда не откроется, пока не будет получена предыдущая. Если пользователь пропускает один или несколько дней, он продолжает с того шага, где остановился; за пропущенные дни награды не полагаются.\n- `rolling_unskippable` — Разблокирует награду за следующий шаг каждые 24 часа, отсчет начинается со значения, указанного в параметре `date_start`. Прогресс последовательный: новая награда не откроется, пока не будет получена предыдущая. Если пользователь пропустил день, его прогресс сбрасывается и он начинает заново с первого шага."
},
"calendar_hard_date_start": {
"type": "string",
"format": "date-time",
"example": "2020-04-15T18:16:00+05:00",
"description": "Дата, когда начнет действовать ежедневная награда."
},
"calendar_hard_is_recurrent": {
"type": "boolean",
"example": true,
"default": false,
"description": "Перезапускается ли ежедневная награда. Если передано значение `true`, ежедневная награда автоматически сбрасывается в конце периода ее действия. Следующие значения для параметров `start_date` и `end_date` рассчитываются исходя из количества уровней ежедневной награды и времени старта ежедневной награды, заданном в параметре `start_date`."
},
"calendar-hard-daily-chain-base": {
"type": "object",
"description": "Базовые свойства ежедневной награды с типом `calendar_hard`.",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/daily_chain_type"
},
{
"enum": [
"calendar_hard"
]
}
]
},
"date_start": {
"$ref": "#/components/schemas/calendar_hard_date_start"
},
"is_recurrent": {
"$ref": "#/components/schemas/calendar_hard_is_recurrent"
}
}
},
"daily_chain_id": {
"type": "integer",
"example": 9,
"description": "Уникальный ID ежеденевной награды."
},
"daily_chain_date_end": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2020-04-15T18:16:00+05:00",
"description": "Дата окончания срока действия ежедневных наград. Может быть null. При установке типа `calendar_hard` эта дата будет автоматически рассчитана по количеству добавленных уровней, поэтому можно оставить значение null."
},
"daily_chain_number_of_step": {
"type": "integer",
"example": 3,
"description": "Количество уровней, заданных в ежедневной награде. Каждый уровень означает один день в ежедневной награде."
},
"admin-calendar-hard-daily-chain-short-model": {
"allOf": [
{
"$ref": "#/components/schemas/calendar-hard-daily-chain-base"
},
{
"type": "object",
"description": "Ежедневная награда с типом `calendar_hard` (краткая версия).",
"properties": {
"id": {
"$ref": "#/components/schemas/daily_chain_id"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"order": {
"$ref": "#/components/schemas/order"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"date_end": {
"$ref": "#/components/schemas/daily_chain_date_end"
},
"is_enabled": {
"$ref": "#/components/schemas/is_enabled"
},
"number_of_steps": {
"$ref": "#/components/schemas/daily_chain_number_of_step"
}
}
}
]
},
"daily_rolling_chain_date_start": {
"type": "string",
"format": "date-time",
"example": "2020-04-15T18:16:00+05:00",
"description": "Дата и время, когда начнет действовать ежедневная награда. Это время также определяет момент ежедневного сброса, когда пользователи могут получить свою награду."
},
"rolling_date_end": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2020-04-15T18:16:00+05:00",
"description": "Дата окончания срока действия ежедневной награды."
},
"rolling_is_recurrent": {
"type": "boolean",
"example": true,
"default": false,
"description": "Перезапускается ли ежедневная награда. Если передано значение `true`, ежедневная награда перезапускается после того, как пользователь проходит все уровни, и он может начать заново с первого уровня. Перезапуск возможен только в пределах активного периода награды, заданного параметрами `date_start` и `date_end`."
},
"rolling-skippable-daily-chain-base": {
"type": "object",
"description": "Базовые свойства ежедневной награды с типом rolling_skippable.",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/daily_chain_type"
},
{
"enum": [
"rolling_skippable"
]
}
]
},
"date_start": {
"$ref": "#/components/schemas/daily_rolling_chain_date_start"
},
"date_end": {
"$ref": "#/components/schemas/rolling_date_end"
},
"is_recurrent": {
"$ref": "#/components/schemas/rolling_is_recurrent"
}
}
},
"admin-rolling-skippable-daily-chain-short-model": {
"allOf": [
{
"$ref": "#/components/schemas/rolling-skippable-daily-chain-base"
},
{
"type": "object",
"description": "Ежедневная награда с типом `rolling_skippable` (краткая версия).",
"properties": {
"id": {
"$ref": "#/components/schemas/daily_chain_id"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"order": {
"$ref": "#/components/schemas/order"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"is_enabled": {
"$ref": "#/components/schemas/is_enabled"
},
"number_of_steps": {
"$ref": "#/components/schemas/daily_chain_number_of_step"
}
}
}
]
},
"rolling-unskippable-daily-chain-base": {
"type": "object",
"description": "Базовые свойства ежедневной награды с типом `rolling_unskippable`.",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/daily_chain_type"
},
{
"enum": [
"rolling_unskippable"
]
}
]
},
"date_start": {
"$ref": "#/components/schemas/daily_rolling_chain_date_start"
},
"date_end": {
"$ref": "#/components/schemas/rolling_date_end"
},
"is_recurrent": {
"$ref": "#/components/schemas/rolling_is_recurrent"
}
}
},
"admin-rolling-unskippable-daily-chain-short-model": {
"allOf": [
{
"$ref": "#/components/schemas/rolling-unskippable-daily-chain-base"
},
{
"type": "object",
"description": "Ежедневная награда с типом `rolling_unskippable` (краткая версия).",
"properties": {
"id": {
"$ref": "#/components/schemas/daily_chain_id"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"order": {
"$ref": "#/components/schemas/order"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"is_enabled": {
"$ref": "#/components/schemas/is_enabled"
},
"number_of_steps": {
"$ref": "#/components/schemas/daily_chain_number_of_step"
}
}
}
]
},
"admin-daily-chain-short-model": {
"oneOf": [
{
"$ref": "#/components/schemas/admin-calendar-hard-daily-chain-short-model"
},
{
"$ref": "#/components/schemas/admin-rolling-skippable-daily-chain-short-model"
},
{
"$ref": "#/components/schemas/admin-rolling-unskippable-daily-chain-short-model"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"calendar_hard": "#/components/schemas/admin-calendar-hard-daily-chain-short-model",
"rolling_skippable": "#/components/schemas/admin-rolling-skippable-daily-chain-short-model",
"rolling_unskippable": "#/components/schemas/admin-rolling-unskippable-daily-chain-short-model"
}
}
},
"daily_chain_step_number": {
"type": "integer",
"example": 2,
"description": "Номер уровня.",
"nullable": false,
"minimum": 1
},
"modify-daily-chain-item-model": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/sku"
},
"quantity": {
"type": "integer",
"description": "Количество уровней ежедневной награды для этого артикула",
"minimum": 1
}
},
"required": [
"sku",
"quantity"
]
},
"create-daily-chain-step-model": {
"type": "object",
"properties": {
"step_number": {
"$ref": "#/components/schemas/daily_chain_step_number"
},
"items": {
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/components/schemas/modify-daily-chain-item-model"
}
}
},
"required": [
"step_number",
"items"
]
},
"create-calendar-hard-daily-chain-model": {
"allOf": [
{
"$ref": "#/components/schemas/calendar-hard-daily-chain-base"
},
{
"type": "object",
"description": "Ежедневная награда с типом `calendar_hard`.",
"properties": {
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"order": {
"$ref": "#/components/schemas/order"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"is_enabled": {
"$ref": "#/components/schemas/is_enabled"
},
"steps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/create-daily-chain-step-model"
}
}
},
"required": [
"name",
"date_start",
"steps",
"is_enabled",
"type"
]
}
]
},
"create-rolling-skippable-daily-chain-model": {
"allOf": [
{
"$ref": "#/components/schemas/rolling-skippable-daily-chain-base"
},
{
"type": "object",
"description": "Ежедневная награда с типом `rolling_skippable`.",
"properties": {
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"order": {
"$ref": "#/components/schemas/order"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"is_enabled": {
"$ref": "#/components/schemas/is_enabled"
},
"steps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/create-daily-chain-step-model"
}
}
},
"required": [
"name",
"date_start",
"steps",
"is_enabled",
"type"
]
}
]
},
"create-rolling-unskippable-daily-chain-model": {
"allOf": [
{
"$ref": "#/components/schemas/rolling-unskippable-daily-chain-base"
},
{
"type": "object",
"description": "Ежедневная награда с типом `rolling_unskippable`.",
"properties": {
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"order": {
"$ref": "#/components/schemas/order"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"is_enabled": {
"$ref": "#/components/schemas/is_enabled"
},
"steps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/create-daily-chain-step-model"
}
}
},
"required": [
"name",
"date_start",
"steps",
"is_enabled",
"type"
]
}
]
},
"daily-chain-error-model": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
},
"errorMessageExtended": {
"type": [
"object",
"null"
]
}
}
},
"daily_chain_step_id": {
"type": [
"integer",
"null"
],
"example": 10,
"description": "Уникальный идентификатор уровня ежедневной награды",
"minimum": 1
},
"item_type": {
"type": "string",
"description": "Тип товара: `virtual_good`/`virtual_currency`/`bundle`/`unit`."
},
"admin-daily-chain-item-model": {
"type": "object",
"properties": {
"item_id": {
"$ref": "#/components/schemas/item_id"
},
"sku": {
"$ref": "#/components/schemas/sku"
},
"type": {
"$ref": "#/components/schemas/item_type"
},
"name": {
"$ref": "#/components/schemas/two-letter-locale"
},
"description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/image_url"
},
"quantity": {
"type": "integer",
"description": "Количество товара.",
"minimum": 1,
"example": 1
}
}
},
"admin-daily-chain-step-model": {
"type": "object",
"description": "Уровень ежедневной награды.",
"properties": {
"step_id": {
"$ref": "#/components/schemas/daily_chain_step_id"
},
"step_number": {
"$ref": "#/components/schemas/daily_chain_step_number"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/admin-daily-chain-item-model"
}
}
}
},
"admin-calendar-hard-daily-chain-model": {
"allOf": [
{
"$ref": "#/components/schemas/calendar-hard-daily-chain-base"
},
{
"type": "object",
"description": "Ежедневная награда с типом calendar_hard в запросах для администрирования.",
"properties": {
"id": {
"$ref": "#/components/schemas/daily_chain_id"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"order": {
"$ref": "#/components/schemas/order"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"date_end": {
"$ref": "#/components/schemas/daily_chain_date_end"
},
"is_enabled": {
"$ref": "#/components/schemas/is_enabled"
},
"number_of_steps": {
"$ref": "#/components/schemas/daily_chain_number_of_step"
},
"steps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/admin-daily-chain-step-model"
}
}
}
}
]
},
"admin-rolling-skippable-daily-chain-model": {
"allOf": [
{
"$ref": "#/components/schemas/rolling-skippable-daily-chain-base"
},
{
"type": "object",
"description": "Ежедневная награда с типом rolling_skippable в запросах для администрирования.",
"properties": {
"id": {
"$ref": "#/components/schemas/daily_chain_id"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"order": {
"$ref": "#/components/schemas/order"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"is_enabled": {
"$ref": "#/components/schemas/is_enabled"
},
"number_of_steps": {
"$ref": "#/components/schemas/daily_chain_number_of_step"
},
"steps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/admin-daily-chain-step-model"
}
}
}
}
]
},
"admin-rolling-unskippable-daily-chain-model": {
"allOf": [
{
"$ref": "#/components/schemas/rolling-unskippable-daily-chain-base"
},
{
"type": "object",
"description": "Ежедневная награда с типом `rolling_unskippable` в запросах для администрирования.",
"properties": {
"id": {
"$ref": "#/components/schemas/daily_chain_id"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"order": {
"$ref": "#/components/schemas/order"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"is_enabled": {
"$ref": "#/components/schemas/is_enabled"
},
"number_of_steps": {
"$ref": "#/components/schemas/daily_chain_number_of_step"
},
"steps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/admin-daily-chain-step-model"
}
}
}
}
]
},
"admin-daily-chain-long-model": {
"oneOf": [
{
"$ref": "#/components/schemas/admin-calendar-hard-daily-chain-model"
},
{
"$ref": "#/components/schemas/admin-rolling-skippable-daily-chain-model"
},
{
"$ref": "#/components/schemas/admin-rolling-unskippable-daily-chain-model"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"calendar_hard": "#/components/schemas/admin-calendar-hard-daily-chain-model",
"rolling_skippable": "#/components/schemas/admin-rolling-skippable-daily-chain-model",
"rolling_unskippable": "#/components/schemas/admin-rolling-unskippable-daily-chain-model"
}
}
},
"daily_chain_update_step_id": {
"type": [
"integer",
"null"
],
"example": 10,
"description": "Уникальный ID уровня цепочки наград. Укажите его при обновлении, чтобы сохранить прогресс пользователя для этого уровня.",
"minimum": 1
},
"modify-daily-chain-step-model": {
"type": "object",
"properties": {
"step_id": {
"$ref": "#/components/schemas/daily_chain_update_step_id"
},
"step_number": {
"$ref": "#/components/schemas/daily_chain_step_number"
},
"items": {
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/components/schemas/modify-daily-chain-item-model"
}
}
},
"required": [
"step_number",
"items"
]
},
"update-calendar-hard-daily-chain-model": {
"allOf": [
{
"$ref": "#/components/schemas/calendar-hard-daily-chain-base"
},
{
"type": "object",
"description": "Ежедневная награда с типом `calendar_hard`.",
"properties": {
"id": {
"$ref": "#/components/schemas/daily_chain_id"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"order": {
"$ref": "#/components/schemas/order"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"is_enabled": {
"$ref": "#/components/schemas/is_enabled"
},
"steps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/modify-daily-chain-step-model"
}
}
},
"required": [
"name",
"date_start",
"steps",
"is_enabled",
"type"
]
}
]
},
"update-rolling-skippable-daily-chain-model": {
"allOf": [
{
"$ref": "#/components/schemas/rolling-skippable-daily-chain-base"
},
{
"type": "object",
"description": "Ежедневная награда с типом `rolling_skippable`.",
"properties": {
"id": {
"$ref": "#/components/schemas/daily_chain_id"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"order": {
"$ref": "#/components/schemas/order"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"is_enabled": {
"$ref": "#/components/schemas/is_enabled"
},
"steps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/modify-daily-chain-step-model"
}
}
},
"required": [
"name",
"date_start",
"steps",
"is_enabled",
"type"
]
}
]
},
"update-rolling-unskippable-daily-chain-model": {
"allOf": [
{
"$ref": "#/components/schemas/rolling-unskippable-daily-chain-base"
},
{
"type": "object",
"description": "Ежедневная награда с типом `rolling_unskippable`.",
"properties": {
"id": {
"$ref": "#/components/schemas/daily_chain_id"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"order": {
"$ref": "#/components/schemas/order"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"is_enabled": {
"$ref": "#/components/schemas/is_enabled"
},
"steps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/modify-daily-chain-step-model"
}
}
},
"required": [
"name",
"date_start",
"steps",
"is_enabled",
"type"
]
}
]
},
"client-daily-chain-item-model": {
"type": "object",
"properties": {
"item_id": {
"$ref": "#/components/schemas/item_id"
},
"sku": {
"$ref": "#/components/schemas/sku"
},
"type": {
"$ref": "#/components/schemas/item_type"
},
"name": {
"type": "string",
"description": "Название товара."
},
"description": {
"type": [
"string",
"null"
],
"description": "Описание товара."
},
"bundle_type": {
"type": [
"string",
"null"
],
"enum": [
"standard",
"virtual_currency_package"
]
},
"image_url": {
"$ref": "#/components/schemas/image_url"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"quantity": {
"type": "integer",
"description": "Количество товара.",
"minimum": 1,
"example": 1
},
"content": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/client-daily-chain-item-model"
}
}
}
},
"client-daily-chain-step-model": {
"type": "object",
"description": "Уровень ежедневной награды.",
"properties": {
"step_number": {
"$ref": "#/components/schemas/daily_chain_step_number"
},
"status": {
"type": "string",
"example": "claimed",
"enum": [
"claimed",
"claimable",
"blocked",
"claim_in_future"
],
"description": "Определяет награду на уровне для текущего пользователя в цепочке наград.\n\nВозможные значения:\n- `claimed` — Награда за шаг уже получена.\n- `claimable` — Можно получить награду за шаг.\n- `blocked` — Награда за шаг не может быть получена:\n - Для неавторизованных пользователей: все шаги заблокированы.\n - Для типа `calendar_hard`: награда за шаг не была получена, и теперь шаг недоступен.\n - Для типа `rolling_skippable`: шаг заблокирован до тех пор, пока не будет получена награда за предыдущий шаг.\n- `claim_in_future` — Награда за шаг не получена, день получения награды еще не настал."
},
"unlocked_date": {
"type": "integer",
"format": "int64",
"description": "Метка времени Unix (в секундах), когда уровень будет разблокирован."
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/client-daily-chain-item-model"
}
}
}
},
"client-calendar-hard-daily-chain-model": {
"allOf": [
{
"$ref": "#/components/schemas/calendar-hard-daily-chain-base"
},
{
"type": "object",
"description": "Ежедневная награда с типом calendar_hard в клиентских запросах.",
"properties": {
"id": {
"type": "integer",
"example": 9,
"description": "ID ежедневной награды."
},
"name": {
"type": "string",
"example": "Weekly quest",
"description": "Название ежедневной награды."
},
"description": {
"type": [
"string",
"null"
],
"example": "Major weekly quest",
"description": "Описание ежедневной награды."
},
"order": {
"$ref": "#/components/schemas/order"
},
"date_end": {
"$ref": "#/components/schemas/daily_chain_date_end"
},
"steps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/client-daily-chain-step-model"
}
}
}
}
]
},
"client-rolling-skippable-daily-chain-model": {
"allOf": [
{
"$ref": "#/components/schemas/rolling-skippable-daily-chain-base"
},
{
"type": "object",
"description": "Ежедневная награда с типом rolling_skippable в клиентских запросах.",
"properties": {
"id": {
"type": "integer",
"example": 9,
"description": "ID ежедневной награды."
},
"name": {
"type": "string",
"example": "Weekly quest",
"description": "Название ежедневной награды."
},
"description": {
"type": [
"string",
"null"
],
"example": "Major weekly quest",
"description": "Описание ежедневной награды."
},
"order": {
"$ref": "#/components/schemas/order"
},
"steps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/client-daily-chain-step-model"
}
}
}
}
]
},
"client-rolling-unskippable-daily-chain-model": {
"allOf": [
{
"$ref": "#/components/schemas/rolling-unskippable-daily-chain-base"
},
{
"type": "object",
"description": "Ежедневная награда с типом `rolling_unskippable` в клиентских запросах.",
"properties": {
"id": {
"type": "integer",
"example": 9,
"description": "ID ежедневной награды."
},
"name": {
"type": "string",
"example": "Weekly quest",
"description": "Название ежедневной награды."
},
"description": {
"type": [
"string",
"null"
],
"example": "Major weekly quest",
"description": "Описание ежедневной награды."
},
"order": {
"$ref": "#/components/schemas/order"
},
"steps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/client-daily-chain-step-model"
}
}
}
}
]
},
"client-daily-chain-model": {
"oneOf": [
{
"$ref": "#/components/schemas/client-calendar-hard-daily-chain-model"
},
{
"$ref": "#/components/schemas/client-rolling-skippable-daily-chain-model"
},
{
"$ref": "#/components/schemas/client-rolling-unskippable-daily-chain-model"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"calendar_hard": "#/components/schemas/client-calendar-hard-daily-chain-model",
"rolling_skippable": "#/components/schemas/client-rolling-skippable-daily-chain-model",
"rolling_unskippable": "#/components/schemas/client-rolling-unskippable-daily-chain-model"
}
}
},
"offer_chain_date_start": {
"type": "string",
"format": "date-time",
"example": "2020-04-15T18:16:00+05:00",
"description": "Дата начала действия цепочки предложений."
},
"offer_chain_date_end": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2020-04-15T18:16:00+05:00",
"description": "Дата окончания срока действия цепочки предложений. Может быть `null`. Если `date_end` равен `null`, цепочка предложений будет бессрочной."
},
"offer_chain_step_number": {
"type": "integer",
"example": 2,
"description": "Номер уровня.",
"nullable": false,
"minimum": 1
},
"offer_chain_is_free": {
"type": "boolean",
"description": "Указывает, является ли уровень цепочки предложений бесплатным:"
},
"offer_chain_step_price_amount": {
"type": "number",
"example": 99.99,
"description": "Цена уровня в реальной валюте."
},
"offer_chain_step_price_currency": {
"type": "string",
"example": "USD",
"description": "Валюта, в которой указана цена товара. Трехбуквенный код в соответствии со стандартом [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
},
"offer_chain_step_price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"$ref": "#/components/schemas/offer_chain_step_price_amount"
},
"currency": {
"$ref": "#/components/schemas/offer_chain_step_price_currency"
}
},
"required": [
"amount",
"currency"
]
},
"client-offer-chain-item-model": {
"type": "object",
"properties": {
"item_id": {
"$ref": "#/components/schemas/item_id"
},
"sku": {
"$ref": "#/components/schemas/sku"
},
"type": {
"$ref": "#/components/schemas/item_type"
},
"name": {
"type": "string",
"description": "Название товара."
},
"description": {
"type": [
"string",
"null"
],
"description": "Описание товара."
},
"bundle_type": {
"type": [
"string",
"null"
],
"enum": [
"standard",
"virtual_currency_package"
]
},
"image_url": {
"$ref": "#/components/schemas/image_url"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"quantity": {
"type": "integer",
"description": "Количество товара.",
"minimum": 1,
"example": 1
},
"order": {
"$ref": "#/components/schemas/order"
},
"content": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/client-offer-chain-item-model"
}
}
}
},
"client-offer-chain-step-model": {
"type": "object",
"description": "Уровень цепочки предложений.",
"properties": {
"step_number": {
"$ref": "#/components/schemas/offer_chain_step_number"
},
"is_free": {
"$ref": "#/components/schemas/offer_chain_is_free"
},
"is_claimed": {
"type": "boolean",
"example": false,
"description": "Указывает, является ли уровень цепочки предложений платным или бесплатным."
},
"step_price": {
"$ref": "#/components/schemas/offer_chain_step_price"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/client-offer-chain-item-model"
}
},
"step_vp_rewards": {
"type": [
"array",
"null"
],
"description": "Набор призовых баллов из цепочки наград, начисляемых в качестве вознаграждения.",
"items": {
"type": "object",
"properties": {
"item_id": {
"$ref": "#/components/schemas/item_id"
},
"sku": {
"$ref": "#/components/schemas/value-point-sku"
},
"amount": {
"$ref": "#/components/schemas/value-point-amount"
},
"name": {
"$ref": "#/components/schemas/value-point-name"
},
"image_url": {
"$ref": "#/components/schemas/Common_admin-image_url"
},
"is_clan": {
"$ref": "#/components/schemas/is_clan"
}
}
}
},
"step_loyalty_rewards": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "First Loyalty Point",
"description": "Название баллов лояльности."
},
"sku": {
"type": "string",
"example": "0c745ef0-4243-46e1-aa90-54dee07da622",
"description": "Артикул баллов лояльности."
},
"description": {
"type": "string",
"example": "First Loyalty Point Desc",
"description": "Описание баллов лояльности."
},
"image_url": {
"$ref": "#/components/schemas/image_url"
},
"amount": {
"type": "integer",
"example": 1,
"description": "Количество призовых баллов."
}
}
}
}
}
},
"offer_chain_reset_next_date": {
"type": "integer",
"description": "Рассчитанные дата и время следующего сброса цепочки предложений в формате Unix Timestamp.
Например, цепочка предложений сбрасывается ежемесячно начиная с 1 марта 2024 года в 01:00 по времени в Куала-Лумпуре (GMT+8), следующий сброс произойдет 1 апреля 2024 года в 01:00 по часовому поясу Куала-Лумпура (GMT+8), что соответствует 31 марта 2024 года 17:00 по времени GMT+0 или `1711904400000` в формате Unix Timestamp.
Example: `1711904400000`"
},
"offer_chain_recurrent_schedule_client_side": {
"type": [
"object",
"null"
],
"description": "Интервал сброса цепочки предложений.",
"properties": {
"interval_type": {
"type": "string",
"description": "Частота сброса цепочки предложений.",
"enum": [
"weekly",
"monthly",
"hourly"
]
},
"reset_next_date": {
"$ref": "#/components/schemas/offer_chain_reset_next_date"
}
}
},
"client-offer-chain-model": {
"type": "object",
"description": "Цепочка предложений.",
"properties": {
"id": {
"type": "integer",
"example": 9,
"description": "ID цепочки предложений."
},
"name": {
"type": "string",
"example": "Weekly quest",
"description": "Название цепочки предложений."
},
"description": {
"type": [
"string",
"null"
],
"example": "Major weekly quest",
"description": "Описание цепочки предложений."
},
"order": {
"$ref": "#/components/schemas/order"
},
"date_start": {
"$ref": "#/components/schemas/offer_chain_date_start"
},
"date_end": {
"$ref": "#/components/schemas/offer_chain_date_end"
},
"steps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/client-offer-chain-step-model"
}
},
"recurrent_schedule": {
"$ref": "#/components/schemas/offer_chain_recurrent_schedule_client_side"
},
"next_step_number": {
"type": [
"integer",
"null"
],
"description": "Номер следующего уровня цепочки предложений. `null`, если цепочка завершена.",
"example": 1
}
}
},
"offer-chain-error-model": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
},
"errorMessageExtended": {
"type": [
"object",
"null"
]
}
}
},
"offer_chain_id": {
"type": "integer",
"example": 9,
"description": "Уникальный ID цепочки предложений."
},
"offer_chain_interval_type_weekly": {
"type": "string",
"description": "Частота сброса цепочки предложений.",
"enum": [
"weekly"
]
},
"offer_chain_day_of_week": {
"type": "integer",
"description": "День недели, когда происходит сброс, где `1` — понедельник, `7` — воскресенье.",
"minimum": 1,
"maximum": 7
},
"offer_chain_time": {
"type": "string",
"description": "Время сброса цепочки предложений в указанном часовом поясе (с округлением до часов).
Например, время сброса установлено на 01:00 по часовому поясу Куала-Лумпура (GMT+8), значение параметра `time` будет `01:00:00+08:00`.",
"pattern": "((0[0-9]|1[0-9]|2[0-3]):00:00)(\\+|-)(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])",
"example": "01:00:00+08:00"
},
"offer_chain_displayable_reset_start_date": {
"description": "Дата и время первого сброса цепочки предложений.
Например, первый сброс происходит 1 марта 2024 года в 01:00 по времени в Куала-Лумпуре, это соответствует `2024-03-01T01:00:00+08:00` в формате ISO 8601.
Example: `2024-03-01T01:00:00+08:00`",
"type": "string",
"format": "date-time"
},
"offer_chain_displayable_reset_next_date": {
"description": "Рассчитанная дата и время следующего сброса цепочки в формате ISO 8601.
Например, если цепочка предложений сбрасывается ежемесячно начиная с 1 марта 2024 года в 01:00 по времени в Куала-Лумпуре, следующий сброс произойдет 1 апреля 2024 года в 01:00 по времени в Куала-Лумпуре, что соответствует `2024-04-01T01:00:00+08:00` в формате ISO 8601.
Example: `2024-04-01T01:00:00+08:00`",
"type": "string",
"format": "date-time"
},
"offer_chain_interval_type_monthly": {
"type": "string",
"description": "Частота сброса цепочки предложений.",
"enum": [
"monthly"
]
},
"offer_chain_day_of_month": {
"type": "integer",
"description": "День месяца, когда сбрасывается цепочка. Если в месяце меньше дней, чем указано — сброс произойдет в последний день месяца.",
"minimum": 1,
"maximum": 31
},
"offer_chain_interval_type_hourly": {
"type": "string",
"description": "Частота сброса цепочки предложений.",
"enum": [
"hourly"
]
},
"offer_chain_hours_interval": {
"type": "integer",
"description": "Интервал в часах, через который выполняется сброс цепочки предложений.
Отсчет начинается от значения date_start. Например, если `date_start = \"2025-11-15T18:15:00+05:00\"` и `hours_interval = 2`, цепочка предложений будет сбрасываться каждые 2 часа, начиная с `\"2025-11-15T20:15:00+05:00\"`.",
"minimum": 1,
"maximum": 10000
},
"offer_chain_recurrent_schedule": {
"description": "Интервал повторяющегося сброса цепочки предложений.",
"oneOf": [
{
"type": "object",
"title": "interval_type = weekly",
"description": "Еженедельный сброс цепочки предложений.",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/offer_chain_interval_type_weekly"
},
"day_of_week": {
"$ref": "#/components/schemas/offer_chain_day_of_week"
},
"time": {
"$ref": "#/components/schemas/offer_chain_time"
},
"reset_next_date": {
"$ref": "#/components/schemas/offer_chain_reset_next_date"
},
"displayable_reset_start_date": {
"$ref": "#/components/schemas/offer_chain_displayable_reset_start_date"
},
"displayable_reset_next_date": {
"$ref": "#/components/schemas/offer_chain_displayable_reset_next_date"
}
}
},
{
"type": "object",
"title": "interval_type = monthly",
"description": "Ежемесячный сброс цепочки.",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/offer_chain_interval_type_monthly"
},
"day_of_month": {
"$ref": "#/components/schemas/offer_chain_day_of_month"
},
"time": {
"$ref": "#/components/schemas/offer_chain_time"
},
"reset_next_date": {
"$ref": "#/components/schemas/offer_chain_reset_next_date"
},
"displayable_reset_start_date": {
"$ref": "#/components/schemas/offer_chain_displayable_reset_start_date"
},
"displayable_reset_next_date": {
"$ref": "#/components/schemas/offer_chain_displayable_reset_next_date"
}
}
},
{
"type": "object",
"title": "interval_type = hourly",
"description": "Сброс цепочки предложений, выполняемый через временной интервал, заданный в часах.",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/offer_chain_interval_type_hourly"
},
"hours_interval": {
"$ref": "#/components/schemas/offer_chain_hours_interval"
}
}
},
{
"type": "null",
"title": "null"
}
]
},
"admin-offer-chain-short-model": {
"type": "object",
"description": "Цепочка предложений.",
"properties": {
"id": {
"$ref": "#/components/schemas/offer_chain_id"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"order": {
"$ref": "#/components/schemas/order"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"date_start": {
"$ref": "#/components/schemas/offer_chain_date_start"
},
"date_end": {
"$ref": "#/components/schemas/offer_chain_date_end"
},
"is_enabled": {
"$ref": "#/components/schemas/is_enabled"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/offer_chain_recurrent_schedule"
},
"is_always_visible": {
"$ref": "#/components/schemas/chain_is_always_visible"
},
"attribute_conditions": {
"$ref": "#/components/schemas/chain_user-attribute_conditions_model-get"
}
}
},
"offer_chain_recurrent_schedule_create_update": {
"description": "Интервал сброса цепочки предложений.",
"oneOf": [
{
"type": "object",
"title": "interval_type = weekly",
"description": "Еженедельный сброс цепочки предложений.",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/offer_chain_interval_type_weekly"
},
"day_of_week": {
"$ref": "#/components/schemas/offer_chain_day_of_week"
},
"time": {
"$ref": "#/components/schemas/offer_chain_time"
}
},
"required": [
"interval_type",
"time",
"day_of_week"
]
},
{
"type": "object",
"title": "interval_type = monthly",
"description": "Ежемесячный сброс цепочки.",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/offer_chain_interval_type_monthly"
},
"day_of_month": {
"$ref": "#/components/schemas/offer_chain_day_of_month"
},
"time": {
"$ref": "#/components/schemas/offer_chain_time"
}
},
"required": [
"interval_type",
"time",
"day_of_month"
]
},
{
"type": "object",
"title": "interval_type = hourly",
"description": "Сброс цепочки предложений, выполняемый через временной интервал, заданный в часах.",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/offer_chain_interval_type_hourly"
},
"hours_interval": {
"$ref": "#/components/schemas/offer_chain_hours_interval"
}
},
"required": [
"interval_type",
"hours_interval"
]
},
{
"type": "null",
"title": "null"
}
]
},
"modify-offer-chain-item-model": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/sku"
},
"quantity": {
"type": "integer",
"description": "Количество товаров в вознаграждении для этого уровня цепочки.",
"minimum": 1
},
"order": {
"description": "Заказ на вознаграждение за уровень цепочки предложений.",
"type": [
"integer",
"null"
],
"minimum": 0
}
},
"required": [
"sku",
"quantity"
]
},
"create-offer-chain-step-model": {
"type": "object",
"properties": {
"step_number": {
"$ref": "#/components/schemas/offer_chain_step_number"
},
"is_free": {
"$ref": "#/components/schemas/offer_chain_is_free"
},
"items": {
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/components/schemas/modify-offer-chain-item-model"
}
}
},
"required": [
"step_number",
"is_free",
"items"
]
},
"create-offer-chain-model": {
"type": "object",
"description": "Цепочка предложений.",
"properties": {
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"order": {
"$ref": "#/components/schemas/order"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"date_start": {
"$ref": "#/components/schemas/offer_chain_date_start"
},
"date_end": {
"$ref": "#/components/schemas/offer_chain_date_end"
},
"is_enabled": {
"$ref": "#/components/schemas/is_enabled"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/offer_chain_recurrent_schedule_create_update"
},
"steps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/create-offer-chain-step-model"
}
},
"is_always_visible": {
"$ref": "#/components/schemas/chain_is_always_visible"
},
"attribute_conditions": {
"$ref": "#/components/schemas/chain_user-attribute_conditions_model-post"
}
},
"required": [
"name",
"date_start",
"steps",
"is_enabled"
]
},
"offer_chain_step_id": {
"type": [
"integer",
"null"
],
"example": 10,
"description": "Уникальный ID уровня цепочки.",
"minimum": 1
},
"admin-offer-chain-item-model": {
"type": "object",
"properties": {
"item_id": {
"$ref": "#/components/schemas/item_id"
},
"sku": {
"$ref": "#/components/schemas/sku"
},
"type": {
"$ref": "#/components/schemas/item_type"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/image_url"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"quantity": {
"type": "integer",
"description": "Количество товара.",
"minimum": 1,
"example": 1
},
"order": {
"$ref": "#/components/schemas/order"
}
}
},
"admin-offer-chain-step-model": {
"type": "object",
"description": "Уровень цепочки предложений.",
"properties": {
"step_id": {
"$ref": "#/components/schemas/offer_chain_step_id"
},
"step_number": {
"$ref": "#/components/schemas/offer_chain_step_number"
},
"is_free": {
"$ref": "#/components/schemas/offer_chain_is_free"
},
"step_price": {
"$ref": "#/components/schemas/offer_chain_step_price"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/admin-offer-chain-item-model"
}
}
}
},
"admin-offer-chain-long-model": {
"type": "object",
"description": "Цепочка предложений.",
"properties": {
"id": {
"$ref": "#/components/schemas/offer_chain_id"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"order": {
"$ref": "#/components/schemas/order"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"date_start": {
"$ref": "#/components/schemas/offer_chain_date_start"
},
"date_end": {
"$ref": "#/components/schemas/offer_chain_date_end"
},
"is_enabled": {
"$ref": "#/components/schemas/is_enabled"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/offer_chain_recurrent_schedule"
},
"steps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/admin-offer-chain-step-model"
}
},
"is_always_visible": {
"$ref": "#/components/schemas/chain_is_always_visible"
},
"attribute_conditions": {
"$ref": "#/components/schemas/chain_user-attribute_conditions_model-get"
}
}
},
"update_step_id": {
"type": [
"integer",
"null"
],
"example": 10,
"description": "Уникальный ID уровня цепочки. Укажите его при обновлении, чтобы сохранить прогресс пользователя для этого уровня.",
"minimum": 1
},
"modify-offer-chain-step-model": {
"type": "object",
"properties": {
"step_id": {
"$ref": "#/components/schemas/update_step_id"
},
"step_number": {
"$ref": "#/components/schemas/offer_chain_step_number"
},
"is_free": {
"$ref": "#/components/schemas/offer_chain_is_free"
},
"items": {
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/components/schemas/modify-offer-chain-item-model"
}
}
},
"required": [
"step_number",
"is_free",
"items"
]
},
"modify-offer-chain-model": {
"type": "object",
"description": "Цепочка предложений.",
"properties": {
"id": {
"$ref": "#/components/schemas/offer_chain_id"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"order": {
"$ref": "#/components/schemas/order"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"date_start": {
"$ref": "#/components/schemas/offer_chain_date_start"
},
"date_end": {
"$ref": "#/components/schemas/offer_chain_date_end"
},
"is_enabled": {
"$ref": "#/components/schemas/is_enabled"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/offer_chain_recurrent_schedule_create_update"
},
"steps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/modify-offer-chain-step-model"
}
},
"is_always_visible": {
"$ref": "#/components/schemas/chain_is_always_visible"
},
"attribute_conditions": {
"$ref": "#/components/schemas/chain_user-attribute_conditions_model-post"
}
},
"required": [
"name",
"date_start",
"steps",
"is_enabled"
]
},
"bundle_type": {
"type": "string",
"description": "Тип бандла. Возвращается, если тип элемента является бандлом.",
"enum": [
"standard",
"virtual_currency_package",
"partner_side_content"
]
},
"unit_type": {
"type": "string",
"example": "game",
"description": "Тип: `game`."
},
"drm_name": {
"type": "string",
"example": "Steam",
"description": "Название игры на платформе."
},
"drm_sku": {
"type": "string",
"example": "steam",
"description": "Уникальный ID платформы."
},
"Upsell-model": {
"type": "object",
"description": "Тип апселла.",
"properties": {
"type": {
"type": "string",
"enum": [
"fixed_list"
],
"example": true
},
"is_enabled": {
"$ref": "#/components/schemas/is_enabled"
},
"items": {
"type": "array",
"example": [
"game_sku"
],
"default": null,
"description": "Массив артикулов товаров",
"items": {
"type": "string"
}
}
},
"required": [
"is_enabled",
"type",
"items"
]
},
"Upsell-model-not-fixed-list": {
"type": "object",
"description": "Тип апселла.",
"properties": {
"type": {
"type": "string",
"enum": [
"most_sellable",
"only_promotions"
],
"example": true
},
"is_enabled": {
"$ref": "#/components/schemas/is_enabled"
},
"items": {
"type": "array",
"example": [
null
],
"default": null,
"description": "Пустой массив артикулов товаров.",
"items": {
"type": "string"
}
}
},
"required": [
"is_enabled",
"type"
]
},
"Upsell-422-invalid-request": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0401-1102]: Unprocessable entity. The property `is_enabled` is required"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"Virtual-Items-Currency_admin-groups-response": {
"type": "array",
"example": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"default": [],
"description": "Группы, к которым принадлежит товар.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
},
"name": {
"type": "object",
"description": "Название элемента. Должно содержать пары ключ/значение,\nгде ключ — это языковой стандарт в {2}формате \"^[a-z]\", значение — строка.",
"example": {
"en": "Horror",
"de": "Horror"
},
"default": {
"en": "Horror"
},
"additionalProperties": {
"type": "string"
}
}
}
}
},
"Virtual-Items-Currency_client-attributes": {
"type": "array",
"description": "Список атрибутов и их значений, соответствующих товару. Может использоваться для фильтрации каталога.",
"example": {
"value": {
"external_id": "genre",
"name": "Жанр",
"values": [
{
"external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Casual"
},
{
"external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7",
"value": "Strategy"
},
{
"external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8",
"value": "Mobile"
}
]
}
},
"default": [],
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"type": "object",
"description": "Название атрибута.",
"example": "Genre",
"additionalProperties": {
"type": [
"string",
"null"
]
}
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
},
"value": {
"type": "string",
"description": "Значение атрибута.",
"example": "Strategy"
}
}
}
}
}
}
},
"client_virtual_prices_response": {
"type": "array",
"description": "Виртуальные цены.",
"items": {
"type": "object",
"description": "Виртуальная цена.",
"properties": {
"amount": {
"type": "integer",
"example": 100,
"description": "Цена товара в виртуальной валюте."
},
"amount_without_discount": {
"type": "integer",
"example": 200,
"description": "Цена товара в виртуальной валюте без скидки. Всегда равна значению `amount`, так как скидки не применяются к ценам в виртуальной валюте."
},
"sku": {
"type": "string",
"example": "vc_gold",
"description": "Артикул виртуальной валюты."
},
"is_default": {
"type": "boolean",
"example": true,
"description": "Является ли ценой в виртуальной валюте по умолчанию."
},
"image_url": {
"type": [
"string",
"null"
],
"example": "http://image.png",
"description": "URL-адрес изображения виртуальной валюты."
},
"name": {
"type": "string",
"example": "Gold",
"description": "Название виртуальной валюты."
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "Тип товара. Для виртуальной валюты всегда имеет значение `virtual_currency`."
},
"description": {
"type": [
"string",
"null"
],
"example": "In-game currency used to purchase weapons and upgrades",
"description": "Описание виртуальной валюты."
}
}
}
},
"item-periods-response": {
"type": "array",
"description": "Период продажи товара.",
"items": {
"type": "object",
"properties": {
"date_from": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2020-08-11T10:00:00+03:00",
"description": "Дата, когда указанный товар будет доступен для продажи."
},
"date_until": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2020-08-11T20:00:00+03:00",
"description": "Дата, когда указанный товар станет недоступен для продажи. Может быть `null`."
}
}
}
},
"item-custom-attributes-response": {
"type": "object",
"description": "JSON-объект, содержащий атрибуты товара и их значения.",
"format": "json"
},
"Upsell_item": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "big_rocket",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"name": {
"type": "string",
"example": "Big Rocket",
"description": "Название товара."
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "Тип товара: `virtual_good`/`virtual_currency`/`bundle`."
},
"description": {
"type": "string",
"example": "Big Rocket - description",
"description": "Описание товара."
},
"image_url": {
"type": "string",
"example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"description": "URL-адрес изображения."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": [
"object",
"null"
],
"description": "Цены на товар.",
"properties": {
"amount": {
"type": "string",
"example": "100.99",
"description": "Цена товара со скидкой."
},
"amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "Цена товара."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Валюта, в которой указана цена товара. Трехбуквенный код в соответствии со стандартом [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"virtual_item_type": {
"type": "string",
"example": "non-consumable",
"description": "Тип виртуального предмета.\n\nВозможные значения:\n- `consumable` — предмет, исчезающий из инвентаря после использования (например, патроны).\n- `non_consumable` — предмет, остающийся в инвентаре в течение неограниченного времени.\n- `non_renewing_subscription` — предмет с ограниченным сроком действия, который может служить представлением доступа к сервисам или контенту в течение ограниченного периода времени.",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
]
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
}
}
},
"Upsell_item-list": {
"type": "object",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Upsell_item"
}
}
}
},
"error-response-base": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"description": "HTTP-статус ответа."
},
"errorCode": {
"type": "integer",
"description": "Код ошибки."
},
"errorMessage": {
"type": "string",
"description": "Краткое описание ошибки."
},
"transactionId": {
"type": "string",
"description": "ID запроса. Позволяет отслеживать и связывать записи логов для этого запроса или операции. Может использоваться для диагностики, отладки и аудита."
}
}
}
},
"examples": {
"Promotions_200-admin-promotions": {
"value": {
"promotions": [
{
"id": 1,
"promotion_periods": [
{
"date_from": "2020-01-01T00:00:00+03:00",
"date_until": null
}
],
"name": {
"en": "promotion_1"
},
"type": "item_bonus",
"is_enabled": true,
"bonus": [
{
"item": {
"description": null,
"image_url": null,
"sku": "com.xsolla.diamonds_pack_1",
"name": {
"en": "Diamonds pack",
"ru": "Пак кристаллов"
},
"type": "bundle",
"bundle_type": "virtual_currency_package",
"content": []
},
"quantity": 1
}
],
"condition": [
{
"item": {
"description": null,
"image_url": null,
"sku": "com.xsolla.virtual_good_bonus_2",
"name": {
"en": "VG name",
"ru": "Название VG"
},
"type": "virtual_good"
}
}
],
"discount": null
},
{
"id": 2,
"promotion_periods": [
{
"date_from": "2020-01-01T00:00:00+03:00",
"date_until": "2030-01-01T00:00:00+03:00"
}
],
"name": {
"en": "promotion_2"
},
"type": "item_discount",
"is_enabled": false,
"bonus": [],
"condition": [
{
"item": {
"description": null,
"image_url": null,
"sku": "com.xsolla.virtual_good_bonus_2",
"name": {
"en": "VG name",
"ru": "Название VG"
},
"type": "virtual_good"
}
}
],
"discount": {
"percent": "10.99"
}
},
{
"id": 3,
"promotion_periods": [
{
"date_from": "2020-01-01T00:00:00+03:00",
"date_until": "2030-01-01T00:00:00+03:00"
}
],
"name": {
"en": "promotion_3"
},
"type": "coupon_bonus",
"is_enabled": true,
"bonus": [
{
"item": {
"description": null,
"image_url": null,
"sku": "com.xsolla.virtual_good_bonus_2",
"name": {
"en": "VG name",
"ru": "Название VG"
},
"type": "virtual_good"
},
"quantity": 2
}
],
"condition": [
{
"item": {
"external_id": "coupon_2",
"name": {
"en": "Coupon name",
"ru": "Название купона"
},
"is_enabled": true,
"redeem_total_limit": null,
"redeem_user_limit": null,
"redeem_code_limit": 1
}
}
],
"discount": null
},
{
"id": 4,
"promotion_periods": [
{
"date_from": "2018-01-01T00:00:00+03:00",
"date_until": "2031-01-01T00:00:00+03:00"
}
],
"name": {
"en": "promotion_4"
},
"type": "promocode_bonus_discount",
"is_enabled": false,
"bonus": [
{
"item": {
"description": null,
"image_url": null,
"sku": "com.xsolla.virtual_good_bonus_2",
"name": {
"en": "VG name",
"ru": "Название VG"
},
"type": "virtual_good"
},
"quantity": 2
}
],
"condition": [
{
"item": {
"external_id": "coupon_3",
"name": {
"en": "Coupon name",
"ru": "Название купона"
},
"is_enabled": true,
"redeem_total_limit": null,
"redeem_user_limit": null,
"redeem_code_limit": 1
}
}
],
"discount": {
"percent": "12.99"
}
},
{
"id": 5,
"promotion_periods": [
{
"date_from": "2020-01-01T00:00:00+03:00",
"date_until": null
}
],
"name": {
"en": "promotion_5"
},
"type": "cart_bonus",
"is_enabled": true,
"bonus": [
{
"item": {
"description": null,
"image_url": null,
"sku": "com.xsolla.virtual_good_bonus_4",
"name": {
"en": "VG name",
"ru": "Название VG"
},
"type": "virtual_good"
},
"quantity": 1
}
],
"condition": null,
"discount": null
}
],
"total_promotions_count": 5,
"active_promotions_count": 3,
"inactive_promotions_count": 2
}
},
"422-activate-deactivate-promotion": {
"value": {
"statusCode": 422,
"errorCode": 9505,
"errorMessage": "[0401-9505]: Error was occurred while promotion was being updated",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"Promotions_200-get-coupon-rewards": {
"value": {
"bonus": [
{
"item": {
"sku": "com.xsolla.game_1",
"name": {
"en": "Game name"
},
"type": "unit",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"unit_items": [
{
"sku": "com.xsolla.game_key_01",
"name": "Game name",
"type": "game_key",
"is_free": false,
"drm_name": "Steam",
"drm_sku": "steam_key_01"
},
{
"sku": "game_key_02",
"name": "Game name",
"type": "game_key",
"drm_name": "Origin",
"drm_sku": "origin_key_02"
}
]
},
"quantity": 1
},
{
"item": {
"sku": "com.xsolla.game_2",
"name": {
"en": "Game name"
},
"type": "unit",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"unit_items": [
{
"sku": "com.xsolla.game_key_01",
"type": "game_key",
"name": "Game name",
"drm_name": "Steam",
"drm_sku": "steam_key_01"
}
]
},
"quantity": 2
}
],
"discount": {
"percent": "10.00"
},
"is_selectable": true
}
},
"Promotions_200-admin-coupons": {
"value": {
"items": [
{
"external_id": "coupon_44056_1",
"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 Bonus",
"de-DE": "Neujahrsbonus"
},
"is_enabled": true,
"bonus": [
{
"sku": "com.xsolla.elven_sword_1",
"quantity": 1
},
{
"sku": "com.xsolla.elven_shield_1",
"quantity": 2
},
{
"sku": "com.xsolla.elven_gloves_1",
"quantity": 2
}
],
"redeem_user_limit": null,
"redeem_total_limit": null,
"redeem_code_limit": 1,
"total_limit_state": null
},
{
"external_id": "summer2021",
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"name": {
"en-US": "Coupon name",
"de-DE": "Gutscheintitel"
},
"is_enabled": true,
"bonus": [
{
"sku": "com.xsolla.diamonds_1",
"quantity": 100
}
],
"redeem_user_limit": null,
"redeem_total_limit": 100,
"redeem_code_limit": 1,
"total_limit_state": {
"available": 50,
"reserved": 10,
"used": 40
}
}
],
"total_promotions_count": 2,
"active_promotions_count": 2,
"inactive_promotions_count": 0
}
},
"Promotions_200-coupon-code-list": {
"value": {
"codes": [
{
"code": "CODE001"
},
{
"code": "CODE002"
},
{
"code": "CODE003"
},
{
"code": "CODE004"
},
{
"code": "CODE005"
}
],
"total_count": 5
}
},
"Promotions_200-get-promocode-rewards": {
"value": {
"bonus": [
{
"item": {
"sku": "com.xsolla.game_1",
"name": "Game name",
"type": "unit",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"unit_items": [
{
"sku": "com.xsolla.game_key_01",
"name": "Game name",
"type": "game_key",
"is_free": false,
"drm_name": "Steam",
"drm_sku": "steam_key_01"
},
{
"sku": "com.xsolla.game_key_02",
"name": "Game name",
"type": "game_key",
"drm_name": "Origin",
"drm_sku": "origin_key_02"
}
]
},
"quantity": 1
},
{
"item": {
"sku": "com.xsolla.game_2",
"name": "Game name",
"type": "unit",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"unit_items": [
{
"sku": "com.xsolla.game_key_01",
"type": "game_key",
"name": "Game name",
"drm_name": "Steam",
"drm_sku": "steam_key_01"
}
]
},
"quantity": 2
}
],
"discount": {
"percent": "10.00"
},
"is_selectable": true,
"discounted_items": [
{
"sku": "com.xsolla.elven_sword_1",
"discount": {
"percent": "10.00"
}
}
]
}
},
"Promotions_200-admin-promocodes": {
"value": {
"items": [
{
"external_id": "promocode_100_crystals",
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"name": {
"en-US": "New Year Bonus",
"de-DE": "Neujahrsbonus"
},
"is_enabled": true,
"bonus": [
{
"sku": "com.xsolla.elven_sword_1",
"quantity": 1
},
{
"sku": "com.xsolla.elven_shield_1",
"quantity": 2
},
{
"sku": "com.xsolla.elven_gloves_1",
"quantity": 2
}
],
"redeem_user_limit": null,
"redeem_total_limit": null,
"redeem_code_limit": 1,
"total_limit_state": null,
"discount": null,
"discounted_items": null
},
{
"external_id": "summer2021",
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"name": {
"en-US": "Coupon name",
"de-DE": "Gutscheintitel"
},
"is_enabled": true,
"bonus": [
{
"sku": "com.xsolla.diamonds_1",
"quantity": 100
}
],
"redeem_user_limit": null,
"redeem_total_limit": 100,
"redeem_code_limit": null,
"total_limit_state": {
"available": 50,
"reserved": 10,
"used": 40
},
"discount": {
"percent": "10.99"
},
"discounted_items": [
{
"sku": "com.xsolla.elven_sword_1",
"discount": {
"percent": "10.00"
}
}
],
"price_conditions": [
{
"operator": "ge",
"value": "10.0000"
},
{
"operator": "le",
"value": "50.0000"
}
],
"excluded_promotions": [
23,
45
]
}
],
"total_promotions_count": 2,
"active_promotions_count": 2,
"inactive_promotions_count": 0
}
},
"Promotions_200-admin-unique-catalog-offers": {
"value": {
"items": [
{
"external_id": "new_year_bonus",
"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 Bonus",
"de-DE": "Neujahrsbonus"
},
"items": [
"booster",
"booster_mega"
],
"is_enabled": true,
"redeem_user_limit": 1,
"redeem_total_limit": null,
"redeem_code_limit": 1,
"total_limit_state": null
},
{
"external_id": "secret_store",
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": null
}
],
"name": {
"en-US": "Secret store",
"ru-RU": "Тайный магазин"
},
"items": [
"helmet",
"armor",
"sword"
],
"is_enabled": true,
"redeem_user_limit": 1,
"redeem_total_limit": 100,
"redeem_code_limit": 1,
"total_limit_state": {
"available": 50,
"reserved": 10,
"used": 40
}
}
],
"total_promotions_count": 2,
"active_promotions_count": 2,
"inactive_promotions_count": 0
}
},
"404-coupon-not-found": {
"value": {
"statusCode": 404,
"errorCode": 9802,
"errorMessage": "[0401-9802]: Coupon not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"404-user-not-found": {
"value": {
"statusCode": 404,
"errorCode": 5008,
"errorMessage": "[0401-5008]: Could not find User",
"transactionId": "transaction id"
}
},
"Promotions_422-invalid-coupon": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `external_id` is required"
}
},
"code-limit": {
"value": {
"promotion_id": 1,
"items": [
{
"code": "WINTER2023",
"per_code": {
"total": 10,
"available": 7,
"used": 2,
"reserved": 1
}
},
{
"code": "SUMMER2023",
"per_code": {
"total": 5,
"available": 0,
"used": 3,
"reserved": 2
}
}
],
"total_items_count": 2,
"has_more": false
}
},
"401-complex-auth-header-not-found": {
"value": {
"statusCode": 401,
"errorCode": 1501,
"errorMessage": "[0401-1501]: Authorization failed: Authorization header not sent",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"401-complex-auth-incorrect-credentials": {
"value": {
"statusCode": 401,
"errorCode": 1013,
"errorMessage": "[0401-1013]: Token not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"422-user_external_id_invalid": {
"value": {
"statusCode": 404,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity",
"transactionId": "transaction id",
"errorMessageExtended": [
{
"property": "user_external_id",
"message": "Must be at least 1 characters long"
},
{
"property": "user_external_id",
"message": "Does not match the regex pattern ^\\S+$"
}
]
}
},
"404-promotion-by-id-not-found": {
"value": {
"statusCode": 404,
"errorCode": 1101,
"errorMessage": "[0401-1101]: Promotion not found",
"transactionId": "transaction id"
}
},
"422-promotion-without-user-limit": {
"value": {
"statusCode": 422,
"errorCode": 4509,
"errorMessage": "[0401-4509]: Promotion does not have configured user limits.",
"transactionId": "transaction id"
}
},
"422-promotion-out-of-range-available-user-limit": {
"value": {
"statusCode": 422,
"errorCode": 4511,
"errorMessage": "[0401-4511]: Available promotion limit is out of range.",
"transactionId": "transaction id"
}
},
"200-value-points-reward-chain_admin_get-value-point-list": {
"value": {
"items": [
{
"sku": "com.xsolla.reward_vp_1",
"name": {
"en": "Reward VP 1"
},
"type": "value_point",
"is_enabled": true,
"description": {
"en": "Points for reward system"
},
"long_description": {
"en": "Points given to users to get new rewards in a reward chain."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"media_list": [],
"order": 1,
"is_clan": false
},
{
"sku": "com.xsolla.reward_vp_2",
"name": {
"en": "Reward VP 2"
},
"type": "value_point",
"is_enabled": false,
"description": {
"en": "Value points for reward system."
},
"long_description": {
"en": "Value points given to users to get new rewards in a reward chain."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"media_list": [],
"order": 2,
"is_clan": false
},
{
"sku": "com.xsolla.clan_value_point_1",
"name": {
"en": "Clan Reward VP 1"
},
"is_enabled": true,
"description": {
"en": "Value points for clan reward system."
},
"long_description": {
"en": "Value points given to clans to get new rewards in a reward chain."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"media_list": [],
"order": 3,
"is_clan": true
}
]
}
},
"422-property-sku-is-required": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `sku` is required",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"200-value-points-reward-chain_admin_get-value-point": {
"value": {
"sku": "com.xsolla.reward_vp_1",
"name": {
"en": "Reward VP 1"
},
"type": "value_point",
"is_enabled": true,
"description": {
"en": "Points for reward system"
},
"long_description": {
"en": "Points given to users to get new rewards in a reward chain."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"media_list": [],
"order": 1,
"is_clan": false,
"can_delete": false
}
},
"200-value-points-rewards-list": {
"value": {
"items": [
{
"item_id": 14232,
"sku": "com.xsolla.booster_1",
"name": {
"en": "Booster"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"amount": 100
},
{
"item_id": 14232,
"sku": "com.xsolla.booster_mega",
"name": {
"en": "Mega Booster"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"amount": 200
}
]
}
},
"200-client-get-reward-chains-list": {
"value": {
"has_more": false,
"total_items_count": 1,
"items": [
{
"reward_chain_id": 10,
"name": "Weekly quest",
"description": "Big weekly quest",
"long_description": "You can get a lot of additional items just by shopping during the week",
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"order": 1,
"date_start": "2023-04-15T18:16:00+05:00",
"date_end": "2023-04-25T18:16:00+05:00",
"value_point": {
"sku": "com.xsolla.value_point_1",
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"description": null,
"long_description": null,
"amount": 130
},
"clan_type": null,
"top_contributors": [],
"steps": [
{
"step_id": 1,
"name": "Level 1",
"is_claimed": true,
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"price": {
"amount": 100
},
"reward": [
{
"sku": "com.xsolla.box_1",
"name": "Super box",
"type": "bundle",
"description": "Super box with items",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"quantity": 1
},
{
"sku": "com.xsolla.box_2",
"name": "Mega box",
"type": "bundle",
"description": "Mega box with items",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"quantity": 1
}
]
},
{
"step_id": 2,
"name": "Level 2",
"is_claimed": false,
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"price": {
"amount": 200
},
"reward": [
{
"sku": "com.xsolla.box_1",
"name": "Super box",
"type": "bundle",
"description": "Super box with items",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"quantity": 2
},
{
"sku": "com.xsolla.box_2",
"name": "Mega box",
"type": "bundle",
"description": "Mega box with items",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"quantity": 2
}
]
}
],
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"popup_header": null,
"popup_instruction": null,
"popup_image_url": null
},
{
"reward_chain_id": 12,
"name": "Weekly clan quest",
"description": "Major weekly clan quest.",
"long_description": "You and your clan members can get additional items for shopping during a certain month.",
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"order": 2,
"date_start": "2023-04-15T18:16:00+05:00",
"date_end": "2023-10-15T18:16:00+05:00",
"value_point": {
"sku": "com.xsolla.clan_value_point_1",
"name": "Clan Reward VP 1",
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"description": "Value points for clan reward system.",
"long_description": "Value points given to clans to get new rewards in a reward chain.",
"amount": 80
},
"clan_type": "guild",
"top_contributors": [
{
"name": "Rabbit",
"contributed_amount": 100
},
{
"name": "Rocket",
"contributed_amount": 80
},
{
"name": "Rain",
"contributed_amount": 40
}
],
"steps": [
{
"step_id": 1,
"name": "Level 1",
"is_claimed": true,
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"price": {
"amount": 100
},
"reward": [
{
"sku": "com.xsolla.box_1",
"name": "Super box",
"type": "bundle",
"description": "Super box with items",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"quantity": 1
},
{
"sku": "com.xsolla.box_2",
"name": "Mega box",
"type": "bundle",
"description": "Mega box with items",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"quantity": 1
}
]
},
{
"step_id": 2,
"name": "Level 2",
"is_claimed": false,
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"price": {
"amount": 200
},
"reward": [
{
"sku": "com.xsolla.box_1",
"name": "Super box",
"type": "bundle",
"description": "Super box with items",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"quantity": 2
},
{
"sku": "com.xsolla.box_2",
"name": "Mega box",
"type": "bundle",
"description": "Mega box with items",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"quantity": 2
}
]
}
],
"recurrent_schedule": {
"interval_type": "monthly",
"reset_next_date": 1746057600
},
"popup_header": {
"en": "How to unlock rewards"
},
"popup_instruction": {
"en": "You should be a clan member to get clan rewards. You join a clan when a clan member invited you to the clan, and you accepted the invite. You can create your own clan."
},
"popup_image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png"
}
]
}
},
"200-client-get-user-reward-chain-balance": {
"summary": "Reward chain example",
"value": {
"sku": "com.xsolla.value_point_1",
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"description": null,
"long_description": null,
"amount": 130,
"is_clan": false
}
},
"200-client-get-user-clan-reward-chain-balance": {
"summary": "Clan reward chain example",
"value": {
"sku": "com.xsolla.clan_value_point_1",
"name": "Clan Reward VP 1",
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"description": "Value points for clan reward system.",
"long_description": "Value points given to clans to get new rewards in a reward chain.",
"amount": 80,
"is_clan": true
}
},
"200-client-update-user-clan": {
"value": {
"reward": [
{
"sku": "com.xsolla.box_1",
"name": "Super box",
"type": "bundle",
"description": "Super box with items",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"quantity": 1,
"bundle_type": "standard"
},
{
"sku": "com.xsolla.potion_1",
"name": "Mega potion",
"type": "virtual_good",
"description": "Mega potion",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"quantity": 1
}
]
}
},
"200-reward-chain-list": {
"value": {
"has_more": true,
"items": [
{
"name": {
"en": "Reward chain"
},
"reward_chain_id": 1,
"description": {
"en": "Reward chain description"
},
"long_description": {
"en": "Reward chain long description"
},
"is_enabled": true,
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"order": 1,
"periods": [
{
"date_from": "2026-01-01T01:00:00+05:00",
"date_until": "2026-01-31T23:59:59+05:00"
},
{
"date_from": "2026-02-01T01:00:00+05:00",
"date_until": "2026-02-28T23:59:59+05:00"
}
],
"value_point": {
"sku": "com.xsolla.reward_vp_1",
"name": {
"en": "Reward VP 1"
},
"type": "value_point",
"is_enabled": true,
"description": "Value points for standard reward system.",
"long_description": "Value points given to users to get new rewards in a reward chain.",
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"media_list": [],
"order": 1,
"is_clan": false
},
"recurrent_schedule": null,
"attribute_conditions": [
{
"attribute": "race",
"operator": "eq",
"value": "ork",
"type": "string",
"can_be_missing": false
}
],
"is_always_visible": true,
"is_reset_after_end": true
},
{
"name": {
"en": "Clan reward chain"
},
"reward_chain_id": 2,
"description": {
"en": "Clan reward chain description."
},
"long_description": {
"en": "Clan reward chain long description."
},
"is_enabled": true,
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"order": 1,
"periods": [
{
"date_from": "2026-01-01T01:00:00+05:00",
"date_until": "2026-01-31T23:59:59+05:00"
},
{
"date_from": "2026-02-01T01:00:00+05:00",
"date_until": "2026-02-28T23:59:59+05:00"
}
],
"value_point": {
"sku": "com.xsolla.clan_value_point_1",
"name": {
"en": "Clan Reward VP 1"
},
"is_enabled": true,
"description": "Value points for clan reward system.",
"long_description": "Value points given to clans to get new rewards in a reward chain.",
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"media_list": [],
"order": 1,
"is_clan": true
},
"recurrent_schedule": {
"day_of_month": null,
"day_of_week": 2,
"displayable_reset_next_date": "2026-01-06T01:00:00+05:00",
"displayable_reset_start_date": "2026-01-01T01:00:00+05:00",
"interval_type": "weekly",
"reset_next_date": 1767643200,
"time": "01:00:00+05:00"
},
"popup_header": {
"en": "How to unlock rewards"
},
"popup_instruction": {
"en": "You must be a clan member in order to get clan rewards. You join a clan when a clan member invites you to the clan, and you accept the invite. You can also create your own clan."
},
"popup_image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"clan_type": "guild"
}
]
}
},
"200-reward-chain": {
"summary": "Reward chain example",
"value": {
"reward_chain_id": 1,
"name": {
"en": "Reward chain"
},
"description": {
"en": "Reward chain description"
},
"long_description": {
"en": "Reward chain long description"
},
"is_enabled": true,
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"order": 1,
"periods": [
{
"date_from": "2026-01-01T01:00:00+05:00",
"date_until": "2026-01-31T23:59:59+05:00"
},
{
"date_from": "2026-02-01T01:00:00+05:00",
"date_until": "2026-02-28T23:59:59+05:00"
}
],
"value_point": {
"sku": "com.xsolla.reward_vp_1",
"name": {
"en": "Reward VP 1"
},
"type": "value_point",
"is_enabled": true,
"description": {
"en": "Value points for reward system."
},
"long_description": {
"en": "Value points given to users to get new rewards in a reward chain."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"media_list": [],
"order": 1,
"is_clan": false
},
"steps": [
{
"name": {
"en": "First step of the reward chain"
},
"step_id": 1,
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"reward": [
{
"sku": "com.xsolla.item_1",
"quantity": 5
},
{
"sku": "com.xsolla.item_2",
"quantity": 1
}
],
"price": {
"amount": 10
}
},
{
"name": {
"en": "Second step of the reward chain"
},
"step_id": 2,
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"reward": [
{
"sku": "com.xsolla.item_3",
"quantity": 5
},
{
"sku": "com.xsolla.item_4",
"quantity": 1
}
],
"price": {
"amount": 15
}
}
],
"recurrent_schedule": {
"day_of_week": 2,
"displayable_reset_next_date": "2026-01-06T01:00:00+05:00",
"displayable_reset_start_date": "2026-01-01T01:00:00+05:00",
"interval_type": "weekly",
"reset_next_date": 1767643200,
"time": "01:00:00+05:00"
},
"attribute_conditions": [
{
"attribute": "race",
"operator": "eq",
"value": "ork",
"type": "string",
"can_be_missing": false
}
],
"is_always_visible": true,
"is_reset_after_end": true
}
},
"200-clan-reward-chain": {
"summary": "Clan reward chain example",
"value": {
"reward_chain_id": 1,
"name": {
"en": "Clan reward chain"
},
"description": {
"en": "Clan reward chain description."
},
"long_description": {
"en": "Clan reward chain long description."
},
"is_enabled": true,
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"order": 1,
"periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2021-04-15T18:16:00+05:00"
}
],
"value_point": {
"sku": "com.xsolla.clan_value_point_1",
"name": {
"en": "Clan Reward VP 1"
},
"is_enabled": true,
"description": {
"en": "Value points for clan reward system."
},
"long_description": {
"en": "Value points given to clans to get new rewards in a certain reward chain."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"media_list": [],
"order": 1,
"is_clan": true
},
"steps": [
{
"name": {
"en": "First step of the reward chain"
},
"step_id": 1,
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"reward": [
{
"sku": "com.xsolla.item_1",
"quantity": 5
},
{
"sku": "com.xsolla.item_2",
"quantity": 1
}
],
"price": {
"amount": 10
}
},
{
"name": {
"en": "Second step of the reward chain"
},
"step_id": 2,
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"reward": [
{
"sku": "com.xsolla.item_3",
"quantity": 5
},
{
"sku": "com.xsolla.item_4",
"quantity": 1
}
],
"price": {
"amount": 15
}
}
],
"recurrent_schedule": {
"day_of_week": 2,
"displayable_reset_next_date": "2023-03-07T11:00:00+08:00",
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"interval_type": "weekly",
"reset_next_date": 1677553200,
"time": "11:00:00+08:00"
},
"popup_header": {
"en": "How to unlock rewards"
},
"popup_instruction": {
"en": "You must be a clan member in order to get clan rewards. You join a clan when a clan member invites you to the clan, and you accept the invite. You can also create your own clan."
},
"popup_image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"clan_type": "guild"
}
},
"200-admin-daily-chain-list": {
"summary": "Daily reward list example",
"value": {
"has_more": false,
"total_items_count": 3,
"items": [
{
"id": 1,
"name": {
"en": "Daily reward",
"ru": "Ежедневная награда"
},
"description": {
"en": "Daily reward short description"
},
"order": 1,
"number_of_steps": 10,
"date_start": "2023-04-15T18:16:00+05:00",
"date_end": "2025-04-25T18:16:00+05:00",
"is_enabled": false,
"is_recurrent": true,
"type": "calendar_hard"
},
{
"id": 2,
"name": {
"en": "Monthly daily reward",
"ru": "Ежедневные награды в цепочке на месяц"
},
"description": {
"en": "Monthly daily reward short description"
},
"order": 2,
"number_of_steps": 13,
"date_start": "2025-04-15T00:00:00+08:00",
"date_end": "2025-04-28T15:00:00+08:00",
"is_enabled": false,
"is_recurrent": true,
"type": "calendar_hard"
},
{
"id": 3,
"name": {
"en": "Login reward"
},
"description": {
"en": "Login reward short description"
},
"order": 3,
"number_of_steps": 7,
"date_start": "2023-05-01T18:16:00+05:00",
"date_end": "2025-05-31T18:16:00+05:00",
"is_enabled": true,
"is_recurrent": true,
"type": "rolling_skippable"
},
{
"id": 4,
"name": {
"en": "Daily reward",
"ru": "Ежедневная награда"
},
"description": {
"en": "Daily reward short description"
},
"order": 4,
"number_of_steps": 10,
"date_start": "2023-04-15T18:16:00+05:00",
"date_end": "2025-04-25T18:16:00+05:00",
"is_enabled": true,
"is_recurrent": true,
"type": "calendar_hard"
},
{
"id": 5,
"name": {
"en": "Unskippable login reward"
},
"description": {
"en": "Unskippable login reward short description"
},
"order": 3,
"number_of_steps": 7,
"date_start": "2025-11-01T10:00:00+05:00",
"date_end": "2025-11-30T10:00:00+05:00",
"is_enabled": true,
"is_recurrent": true,
"type": "rolling_unskippable"
}
]
}
},
"422-admin-daily-chain-error-too-many-steps": {
"summary": "Too many steps",
"description": "Daily reward steps max amount limit of 30 items is exceeded. Try specifying less steps.",
"value": {
"statusCode": 422,
"errorCode": 6203,
"errorMessage": "[0401-6203]: Chain step count exceeds the allowed limit",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 0,
"step_count": 31,
"max_steps": 30
}
}
},
"422-admin-daily-chain-error-incorrect-steps-order": {
"summary": "Incorrect steps order",
"description": "Daily reward steps numbers sequence is incorrect. Correct step numbers should be sequential without any gaps or duplicates.",
"value": {
"statusCode": 422,
"errorCode": 6210,
"errorMessage": "[0401-6210]: Chain step numbers are invalid",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 0,
"incorrect_step_numbers": {
"duplicates": [
2,
7
],
"out_of_range": [
7,
8
],
"missing": [
3,
4,
5,
6
]
}
}
}
},
"422-admin-daily-chain-error-item-limit-exceeded": {
"summary": "Item limit exceeded",
"description": "Daily reward step item count exceeds the allowed limit for some steps. Currently only 1 item per step is allowed.",
"value": {
"statusCode": 422,
"errorCode": 6208,
"errorMessage": "[0401-6208]: Chain step item count exceeds the allowed limit for some steps",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 0,
"max_items": 1,
"steps_exceeded_limits": [
{
"step_number": 1,
"items_count": 2
},
{
"step_number": 4,
"items_count": 3
}
]
}
}
},
"422-admin-daily-chain-error-incorrect-items": {
"summary": "Incorrect step items",
"description": "Specified items are not allowed, disabled or not found. Only enabled items of following types are allowed: virtual item, bundle, virtual currency package.",
"value": {
"statusCode": 422,
"errorCode": 6211,
"errorMessage": "[0401-6211]: Chain steps items are not allowed or not found",
"transactionId": "x-x-xX-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 0,
"invalid_items": {
"not_found": [
"vg_deleted_item_1",
"vg_deleted_item_2",
"not_existing_sku_404_1",
"not_existing_sku_404_2"
],
"disabled": [
"vg_disabled_item_1",
"vg_disabled_item_2",
"vc_disabled_1"
],
"invalid_item_type": {
"allowed_item_type_list": [
"virtual_good",
"bundle"
],
"sku_map": {
"vc_enabled_shown_in_store_1": "virtual_currency",
"vc_disabled_1": "virtual_currency",
"unit_enabled_shown_in_store_1": "unit",
"gk_steam_enabled_shown_in_store_1": "game_key"
}
}
}
}
}
},
"422-admin-daily-chain-error-invalid-dates": {
"summary": "Invalid date format",
"description": "Please, ensure dates format is valid.",
"value": {
"statusCode": 422,
"errorCode": 6204,
"errorMessage": "[0401-6204]: Period of a chain is invalid. Please, check the dates in your request",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 0,
"chain_id": 1,
"invalid_format_dates": {
"date_start": "2023-04-15 17:16:00Z",
"date_end": "2025-04-25 19:16:00Z"
}
}
}
},
"422-admin-daily-chain-error-incorrect-period": {
"summary": "Incorrect period of a daily reward",
"description": "Please ensure start date is earlier than end date.",
"value": {
"statusCode": 422,
"errorCode": 6204,
"errorMessage": "[0401-6204]: Period of a chain is invalid. Please, check the dates in your request",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 0,
"chain_id": 1,
"invalid_periods": [
{
"start": "2025-04-25T18:16:00+05:00",
"end": "2023-04-15T18:16:00+05:00"
}
]
}
}
},
"200-admin-daily-chain": {
"summary": "Daily reward example",
"value": {
"id": 3,
"name": {
"en": "Daily reward",
"ru": "Ежедневная награда"
},
"description": {
"en": "Daily reward short description"
},
"date_start": "2023-04-15T18:16:00+05:00",
"date_end": "2025-04-25T18:16:00+05:00",
"order": 1,
"is_recurrent": false,
"number_of_steps": 3,
"steps": [
{
"step_id": 7,
"step_number": 1,
"items": [
{
"item_id": 9010,
"sku": "telescope",
"name": {
"en": "Telescope",
"ru": "Телескоп"
},
"type": "virtual_good",
"description": {
"en": "Allows to see the stars",
"ru": "Позволяет увидеть звезды"
},
"image_url": "https://picture.bundle-picture.png",
"quantity": 1
},
{
"item_id": 9012,
"sku": "health_potion",
"name": {
"en": "Healing potion",
"ru": "Зелье лечения"
},
"type": "virtual_good",
"description": {
"en": "Heal 10% of your health",
"ru": "Лечит 10% здоровья"
},
"image_url": "https://picture.bundle-picture.png",
"quantity": 2
}
]
},
{
"step_id": 6,
"step_number": 2,
"items": [
{
"item_id": 9010,
"sku": "telescope",
"name": {
"en": "Telescope",
"ru": "Телескоп"
},
"type": "virtual_good",
"description": {
"en": "Allows to see the stars",
"ru": "Позволяет увидеть звезды"
},
"image_url": "https://picture.bundle-picture.png",
"quantity": 5
}
]
},
{
"step_id": 5,
"step_number": 3,
"items": [
{
"item_id": 9010,
"sku": "telescope",
"name": {
"en": "Telescope",
"ru": "Телескоп"
},
"type": "virtual_good",
"description": {
"en": "Allows to see the stars",
"ru": "Позволяет увидеть звезды"
},
"image_url": "https://picture.bundle-picture.png",
"quantity": 2
}
]
}
],
"is_enabled": true,
"type": "calendar_hard"
}
},
"404-daily-chain-not-found": {
"summary": "Daily reward is not found",
"description": "Daily reward was not found.",
"value": {
"statusCode": 404,
"errorCode": 6201,
"errorMessage": "[0401-6201]: Chain not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 0,
"chain_id": 4
}
}
},
"422-admin-daily-chain-error-invalid-chain-step-ids": {
"summary": "Daily reward step IDs not found",
"description": "Some of step IDs was not found. Please, double check if specified daily reward step IDs actually exist.",
"value": {
"statusCode": 404,
"errorCode": 6206,
"errorMessage": "[0401-6206]: Chain step IDs not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 0,
"chain_id": 1,
"chain_step_id_list": [
404000
]
}
}
},
"422-admin-daily-chain-error-chain-id-mismatch": {
"summary": "Daily reward ID mismatch",
"description": "Daily reward ID specified in the body does not match the URL.",
"value": {
"statusCode": 422,
"errorCode": 6205,
"errorMessage": "[0401-6205]: Chain ID mismatch. Please, check the chain ID in your request body and URL",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 0,
"url_chain_id": 1,
"body_chain_id": 2
}
}
},
"422-admin-daily-chain-error-duplicate-step-ids": {
"summary": "Duplicate daily reward step IDs",
"description": "Please, ensure that daily reward step IDs are unique in the request body.",
"value": {
"statusCode": 422,
"errorCode": 6207,
"errorMessage": "[0401-6207]: Duplicate chain step IDs detected in the request body",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 0,
"chain_step_id_list": [
8,
9,
10
],
"chain_id": 3
}
}
},
"422-admin-daily-chain-error-activated": {
"summary": "Active daily reward cannot be updated",
"description": "Active daily reward have to be deactivated before being updated.",
"value": {
"statusCode": 422,
"errorCode": 6209,
"errorMessage": "[0401-6209]: Active chain cannot be updated. Please deactivate it first",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 0,
"chain_id": 2
}
}
},
"200-client-daily-chain-list": {
"summary": "User's daily reward list example",
"value": {
"has_more": false,
"total_items_count": 3,
"items": [
{
"id": 101,
"name": "Active daily reward",
"description": null,
"date_start": "2025-04-01T18:16:00+05:00",
"date_end": "2025-04-03T18:16:00+05:00",
"order": 1,
"steps": [
{
"step_number": 1,
"items": [
{
"item_id": 9012,
"sku": "health_potion",
"name": "Healing potion",
"type": "virtual_good",
"description": "Heal 10% of your health",
"image_url": "https://picture.bundle-picture.png",
"is_free": false,
"quantity": 1
}
],
"status": "claimed",
"unlocked_date": 1711978560
},
{
"step_number": 2,
"items": [
{
"item_id": 9012,
"sku": "health_potion",
"name": "Healing potion",
"type": "virtual_good",
"description": "Heal 10% of your health",
"image_url": "https://picture.bundle-picture.png",
"is_free": false,
"quantity": 2
}
],
"status": "claimable",
"unlocked_date": 1712064960
},
{
"step_number": 3,
"items": [
{
"item_id": 9011,
"sku": "free_item",
"name": "Free item",
"type": "virtual_good",
"description": "store_item_0_lost_telescope_2_short_description",
"image_url": "https://picture.bundle-picture.png",
"is_free": true,
"quantity": 1
}
],
"status": "claim_in_future",
"unlocked_date": 1712151360
}
],
"type": "calendar_hard"
},
{
"id": 102,
"name": "Active daily reward 2",
"description": null,
"date_start": "2025-05-01T18:16:00+05:00",
"date_end": "2025-05-03T18:16:00+05:00",
"order": 1,
"steps": [
{
"step_number": 1,
"items": [
{
"item_id": 9011,
"sku": "free_item",
"name": "Free item",
"type": "virtual_good",
"description": "store_item_0_lost_telescope_2_short_description",
"image_url": "https://picture.bundle-picture.png",
"is_free": true,
"quantity": 3
}
],
"status": "claimable",
"unlocked_date": 1714560960
},
{
"step_number": 2,
"items": [
{
"item_id": 9012,
"sku": "health_potion",
"name": "Healing potion",
"type": "virtual_good",
"description": "Heal 10% of your health",
"image_url": "https://picture.bundle-picture.png",
"is_free": false,
"quantity": 3
}
],
"status": "claim_in_future",
"unlocked_date": 1714647360
}
],
"type": "calendar_hard"
},
{
"id": 103,
"name": "Active daily reward 3",
"description": null,
"date_start": "2025-04-01T18:16:00+05:00",
"date_end": "2025-04-03T18:16:00+05:00",
"order": 1,
"steps": [
{
"step_number": 1,
"items": [
{
"item_id": 9011,
"sku": "free_item",
"name": "Free item",
"type": "virtual_good",
"description": "store_item_0_lost_telescope_2_short_description",
"image_url": "https://picture.bundle-picture.png",
"is_free": true,
"quantity": 3
}
],
"status": "claimable",
"unlocked_date": 1711978560
},
{
"step_number": 2,
"items": [
{
"item_id": 9012,
"sku": "health_potion",
"name": "Healing potion",
"type": "virtual_good",
"description": "Heal 10% of your health",
"image_url": "https://picture.bundle-picture.png",
"is_free": false,
"quantity": 3
}
],
"status": "blocked",
"unlocked_date": 1712064960
},
{
"step_number": 3,
"items": [
{
"item_id": 9012,
"sku": "health_potion",
"name": "Healing potion",
"type": "virtual_good",
"description": "Heal 10% of your health",
"image_url": "https://picture.bundle-picture.png",
"is_free": false,
"quantity": 3
}
],
"status": "blocked",
"unlocked_date": 1712151360
}
],
"type": "calendar_hard"
},
{
"id": 104,
"name": "Active daily rolling reward",
"description": null,
"date_start": "2025-04-01T10:00:00+05:00",
"date_end": "2025-04-28T10:00:00+05:00",
"order": 1,
"steps": [
{
"step_number": 1,
"items": [
{
"item_id": 1001,
"sku": "item_one",
"name": "Item One",
"type": "virtual_good",
"description": "Item one description",
"image_url": "https://picture.bundle-picture.png",
"is_free": true,
"quantity": 1
}
],
"status": "claimed",
"unlocked_date": -1
},
{
"step_number": 2,
"items": [
{
"item_id": 1002,
"sku": "item_two",
"name": "Item Two",
"type": "virtual_good",
"description": "Item two description",
"image_url": "https://picture.bundle-picture.png",
"is_free": false,
"quantity": 1
}
],
"status": "claimable",
"unlocked_date": 1712064960
},
{
"step_number": 3,
"items": [
{
"item_id": 1003,
"sku": "item_three",
"name": "Item Three",
"type": "virtual_good",
"description": "Item three description",
"image_url": "https://picture.bundle-picture.png",
"is_free": false,
"quantity": 1
}
],
"status": "claim_in_future",
"unlocked_date": 1712151360
}
],
"type": "rolling_skippable"
}
]
}
},
"200-client-daily-chain": {
"summary": "User's daily reward example",
"value": {
"id": 101,
"name": "Active daily reward",
"description": "Active daily reward description",
"date_start": "2025-04-01T18:16:00+05:00",
"date_end": "2025-04-03T18:16:00+05:00",
"order": 1,
"steps": [
{
"step_number": 1,
"items": [
{
"item_id": 10001,
"sku": "bundle_with_items",
"name": "Bundle with awesome stuff!",
"type": "bundle",
"description": "Many stuff",
"image_url": "https://picture.bundle-with-many-stuff.png",
"bundle_type": "standard",
"is_free": false,
"content": [
{
"item_id": 1,
"sku": "d0df11c5-f7c4-4907-9ae1-7dd40cecab05",
"name": "virtual_good_one",
"type": "virtual_good",
"description": "Virtual good one",
"image_url": "https://picture.virtual-good-picture.png",
"is_free": false,
"quantity": 1
},
{
"item_id": 2,
"sku": "coins",
"name": "Gold Coins",
"type": "virtual_currency",
"description": "Gold Coins",
"image_url": "https://picture.gold_coins.png",
"is_free": false,
"quantity": 100
}
],
"quantity": 1
}
],
"status": "blocked",
"unlocked_date": 1711978560
},
{
"step_number": 2,
"items": [
{
"item_id": 9012,
"sku": "health_potion",
"name": "Healing potion",
"type": "virtual_good",
"description": "Heal 10% of your health",
"image_url": "https://picture.bundle-picture.png",
"is_free": false,
"quantity": 1
}
],
"status": "claimed",
"unlocked_date": 1712064960
},
{
"step_number": 3,
"items": [
{
"item_id": 9012,
"sku": "health_potion",
"name": "Healing potion",
"type": "virtual_good",
"description": "Heal 10% of your health",
"image_url": "https://picture.bundle-picture.png",
"is_free": false,
"quantity": 2
}
],
"status": "claimable",
"unlocked_date": 1712151360
},
{
"step_number": 4,
"items": [
{
"item_id": 9011,
"sku": "free_item",
"name": "Free item",
"type": "virtual_good",
"description": "store_item_0_lost_telescope_2_short_description",
"image_url": "https://picture.bundle-picture.png",
"is_free": false,
"quantity": 1
}
],
"status": "claim_in_future",
"unlocked_date": 1712237760
}
],
"type": "calendar_hard"
}
},
"404-daily-chain-step-not-found": {
"summary": "Daily reward step not found",
"description": "Daily reward step was not found.",
"value": {
"statusCode": 404,
"errorCode": 6304,
"errorMessage": "[0401-6304]: Daily Chain Step not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"chain_id": 100,
"step_number": 1
}
}
},
"422-daily-chain-claim-error-invalid-step": {
"summary": "Can't claim step reward",
"description": "Ensure the user has not previously claimed the reward and that the correct step in the daily reward is selected for claiming.",
"value": {
"statusCode": 422,
"errorCode": 6405,
"errorMessage": "[0401-6405]: This step is not available to be claimed by the user.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"chain_id": 1,
"step_number": 1
}
}
},
"200-client-offer-chain-list": {
"summary": "User's offer chain list example",
"value": {
"has_more": false,
"total_items_count": 3,
"items": [
{
"id": 101,
"name": "Active offer chain",
"description": null,
"date_start": "2018-04-15T18:16:00+05:00",
"date_end": "2025-04-25T18:16:00+05:00",
"order": 1,
"recurrent_schedule": null,
"steps": [
{
"step_number": 1,
"is_free": false,
"items": [
{
"item_id": 9012,
"sku": "health_potion",
"name": "Healing potion",
"type": "virtual_good",
"description": "Heal 10% of your health",
"image_url": "https://picture.bundle-picture.png",
"is_free": false,
"quantity": 1,
"order": 0
}
],
"is_claimed": false,
"step_price": {
"amount": 99.99,
"currency": "USD"
},
"step_vp_rewards": [
{
"item_id": 6039,
"sku": "test_value_point_39",
"amount": 15,
"name": "store_item_0_test_value_point_name",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/female/accessory/female_crossnecklace_2_silver-01.png",
"is_clan": true
}
]
},
{
"step_number": 2,
"is_free": false,
"items": [
{
"item_id": 9012,
"sku": "health_potion",
"name": "Healing potion",
"type": "virtual_good",
"description": "Heal 10% of your health",
"image_url": "https://picture.bundle-picture.png",
"is_free": false,
"quantity": 2,
"order": 0
}
],
"is_claimed": false,
"step_price": {
"amount": 199.98,
"currency": "USD"
},
"step_vp_rewards": [
{
"item_id": 6039,
"sku": "test_value_point_39",
"amount": 30,
"name": "store_item_0_test_value_point_name",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/female/accessory/female_crossnecklace_2_silver-01.png",
"is_clan": true
}
]
},
{
"step_number": 3,
"is_free": true,
"items": [
{
"item_id": 9011,
"sku": "free_item",
"name": "Free item",
"type": "virtual_good",
"description": "store_item_0_lost_telescope_2_short_description",
"image_url": "https://picture.bundle-picture.png",
"is_free": true,
"quantity": 1,
"order": 0
}
],
"is_claimed": false,
"step_price": null,
"step_vp_rewards": null
}
],
"next_step_number": 1
},
{
"id": 102,
"name": "Active offer chain 2",
"description": null,
"date_start": "2018-04-15T18:16:00+05:00",
"date_end": "2025-04-25T18:16:00+05:00",
"order": 1,
"recurrent_schedule": null,
"steps": [
{
"step_number": 1,
"is_free": true,
"items": [
{
"item_id": 9011,
"sku": "free_item",
"name": "Free item",
"type": "virtual_good",
"description": "store_item_0_lost_telescope_2_short_description",
"image_url": "https://picture.bundle-picture.png",
"is_free": true,
"quantity": 3,
"order": 0
}
],
"is_claimed": false,
"step_price": null,
"step_vp_rewards": null
},
{
"step_number": 2,
"is_free": true,
"items": [
{
"item_id": 9012,
"sku": "health_potion",
"name": "Healing potion",
"type": "virtual_good",
"description": "Heal 10% of your health",
"image_url": "https://picture.bundle-picture.png",
"is_free": false,
"quantity": 3,
"order": 0
}
],
"is_claimed": false,
"step_price": null,
"step_vp_rewards": [
{
"item_id": 6039,
"sku": "test_value_point_39",
"amount": 45,
"name": "store_item_0_test_value_point_name",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/female/accessory/female_crossnecklace_2_silver-01.png",
"is_clan": true
}
]
},
{
"step_number": 3,
"is_free": true,
"items": [],
"is_claimed": false,
"step_price": null,
"step_vp_rewards": null
}
],
"next_step_number": 1
},
{
"id": 103,
"name": "Active offer chain 3",
"description": null,
"date_start": "2018-04-15T18:16:00+05:00",
"date_end": "2025-04-25T18:16:00+05:00",
"order": 1,
"recurrent_schedule": null,
"steps": [
{
"step_number": 1,
"is_free": true,
"items": [
{
"item_id": 9011,
"sku": "free_item",
"name": "Free item",
"type": "virtual_good",
"description": "store_item_0_lost_telescope_2_short_description",
"image_url": "https://picture.bundle-picture.png",
"is_free": true,
"quantity": 3,
"order": 0
}
],
"is_claimed": false,
"step_price": null,
"step_vp_rewards": null
},
{
"step_number": 2,
"is_free": false,
"items": [
{
"item_id": 9012,
"sku": "health_potion",
"name": "Healing potion",
"type": "virtual_good",
"description": "Heal 10% of your health",
"image_url": "https://picture.bundle-picture.png",
"is_free": false,
"quantity": 3,
"order": 0
}
],
"is_claimed": false,
"step_price": {
"amount": 299.97,
"currency": "USD"
},
"step_vp_rewards": [
{
"item_id": 6039,
"sku": "test_value_point_39",
"amount": 45,
"name": "store_item_0_test_value_point_name",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/female/accessory/female_crossnecklace_2_silver-01.png",
"is_clan": true
}
]
},
{
"step_number": 3,
"is_free": true,
"items": [],
"is_claimed": false,
"step_price": null,
"step_vp_rewards": null
}
],
"next_step_number": 1
}
]
}
},
"200-client-offer-chain": {
"summary": "User's offer chain example",
"value": {
"id": 4,
"name": "Offer chain with bundles",
"description": null,
"date_start": "2010-04-15T18:16:00+05:00",
"date_end": "2025-04-25T18:16:00+05:00",
"order": 1,
"recurrent_schedule": null,
"steps": [
{
"step_number": 1,
"is_free": false,
"items": [
{
"item_id": 7008,
"sku": "bundle_with_many_items",
"name": "Bundle with many awesome stuff!",
"type": "bundle",
"description": "Many stuff",
"image_url": "https://picture.bundle-with-many-stuff.png",
"bundle_type": "standard",
"is_free": false,
"content": [
{
"item_id": 1,
"sku": "d0df11c5-f7c4-4907-9ae1-7dd40cecab05",
"name": "Virtual Good Bundle",
"type": "virtual_good",
"description": "virtual_good_short_description_d0df11c5-f7c4-4907-9ae1-7dd40cecab05",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/female/accessory/female_crossnecklace_2_silver-01.png",
"is_free": false,
"quantity": 1
},
{
"item_id": 7009,
"sku": "vg-in-bundle-big-rocket",
"name": "Big Rocket",
"type": "virtual_good",
"description": "Big Rocket - short description",
"image_url": "https://picture.bigrocket.png",
"is_free": false,
"quantity": 1
},
{
"item_id": 7010,
"sku": "vc-in-bundle-gold-coins",
"name": "Gold Coins",
"type": "virtual_currency",
"description": "Gold Coins - short description",
"image_url": "https://picture.gold_coins.png",
"is_free": true,
"quantity": 100
},
{
"item_id": 7011,
"sku": "digital-content-drm-in-bundle-awesome-game",
"name": "Some Game",
"type": "virtual_good",
"description": "Some Game - short description",
"image_url": "https://picture.some_game.png",
"is_free": true,
"quantity": 1
},
{
"item_id": 7012,
"sku": "bundle-in-bundle-another-bundle",
"name": "Some Bundle in Bundle",
"type": "bundle",
"description": "Bundle - short description",
"image_url": "https://picture.bundle-picture.png",
"bundle_type": "standard",
"is_free": true,
"content": [
{
"item_id": 7010,
"sku": "vc-in-bundle-gold-coins",
"name": "Gold Coins",
"type": "virtual_currency",
"description": "Gold Coins - short description",
"image_url": "https://picture.gold_coins.png",
"is_free": true,
"quantity": 1
}
],
"quantity": 1
},
{
"item_id": 7013,
"sku": "lootbox-in-bundle-awesome-game",
"name": "Some Lootbox",
"type": "lootbox",
"description": "Lootbox in bundle - short description",
"image_url": "https://picture.lootbox-picture.png",
"is_free": true,
"quantity": 1
}
],
"quantity": 5,
"order": 0
}
],
"is_claimed": false,
"step_price": {
"amount": 499.95,
"currency": "USD"
},
"step_vp_rewards": null
},
{
"step_number": 2,
"is_free": true,
"items": [
{
"item_id": 7007,
"sku": "bundle-empty",
"name": "Empty bundle",
"type": "bundle",
"description": "No",
"image_url": "https://picture.bundle-no-items.png",
"bundle_type": "standard",
"is_free": true,
"content": [],
"quantity": 10,
"order": 0
}
],
"is_claimed": false,
"step_price": null,
"step_vp_rewards": null
}
],
"next_step_number": 1
}
},
"404-offer-chain-not-found": {
"summary": "Chain not found",
"description": "Offer chain step was not found.",
"value": {
"statusCode": 404,
"errorCode": 6201,
"errorMessage": "[0401-6201]: Chain not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 0,
"chain_id": 4
}
}
},
"404-offer-chain-step-not-found": {
"summary": "Chain step not found",
"description": "Offer chain step was not found.",
"value": {
"statusCode": 404,
"errorCode": 6304,
"errorMessage": "[0401-6304]: Offer Chain Step not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"chain_id": 100,
"step_number": 1
}
}
},
"422-offer-chain-claim-error-invalid-step": {
"summary": "Cannot claim step reward",
"description": "The user must claim all previous steps, and the request must use a valid call – Create order for paid offer chain step, Claim free offer chain step for free ones.\n\nThis error is returned if one or more of the following conditions are not met:- The offer chain exists, is enabled, and not deleted.
- The target step exists, is enabled, and marked as free.
- The step has not already been claimed by the user. In case of a recurring chain, this check is based on the user progress of the current iteration.
- All previous steps in the chain (by step number) have been claimed or purchased. In case of a recurring chain, this check also considers the user progress of the current iteration.
",
"value": {
"statusCode": 422,
"errorCode": 6306,
"errorMessage": "[0401-6306]: This step is not valid to claim by user.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"chain_id": 1,
"step_number": 1
}
}
},
"200-admin-offer-chain-list": {
"summary": "Offer chain list example",
"value": {
"has_more": false,
"items": [
{
"id": 1,
"name": {
"en": "New personalized default offer chain",
"ru": "Новая персонализированная цепочка предложений по умолчанию",
"de": "Neue personalisierte Standard-Angebotskette",
"fr": "Nouvelle chaîne d'offres personnalisée par défaut",
"it": "Nuova catena di offerte personalizzata predefinita"
},
"description": {
"en": "Default personalized offer chain for users that do not meet the conditions of other personalized chains",
"ru": "Персонализированная цепочка по умолчанию для пользователей, не подходящих под условия других персонализированных цепочек",
"de": "Standard-personalisierte Angebotskette für Benutzer, die die Bedingungen anderer personalisierter Ketten nicht erfüllen",
"fr": "Chaîne d'offres personnalisée par défaut pour les utilisateurs qui ne répondent pas aux conditions des autres chaînes personnalisées",
"it": "Catena di offerte personalizzata predefinita per gli utenti che non soddisfano le condizioni di altre catene personalizzate"
},
"order": 1,
"date_start": "2023-04-15T18:16:00+05:00",
"date_end": "2025-04-25T18:16:00+05:00",
"is_enabled": true,
"recurrent_schedule": null,
"is_always_visible": false
},
{
"id": 2,
"name": {
"en": "New personalized offer chain",
"ru": "Новая персонализированная цепочка предложений",
"de": "Neue personalisierte Angebotskette",
"fr": "Nouvelle chaîne d'offres personnalisée",
"it": "Nuova catena di offerte personalizzata"
},
"description": {
"en": "Personalized offer chain with user attribute conditions - for level 10 and above elves who reached level 10 no later than 2026-01-01 00:00:00, inclusive",
"ru": "Персонализированная цепочка предложений с условиями по атрибутам пользователя - для эльфов уровня 10 и выше, достигших 10 уровня не позднее 2026-01-01 00:00:00 включительно",
"de": "Personalisierte Angebotskette mit Benutzerattributbedingungen - für Elfen der Stufe 10 und höher, die Stufe 10 spätestens am 2026-01-01 00:00:00 erreicht haben, einschließlich",
"fr": "Chaîne d'offres personnalisée avec des conditions d'attribut utilisateur - pour les elfes de niveau 10 et plus qui ont atteint le niveau 10 au plus tard le 2026-01-01 00:00:00, inclus",
"it": "Catena di offerte personalizzata con condizioni di attributo utente - per elfi di livello 10 e superiore che hanno raggiunto il livello 10 non più tardi del 2026-01-01 00:00:00, inclusi"
},
"order": 2,
"date_start": "2023-04-15T18:16:00+05:00",
"date_end": "2025-04-25T18:16:00+05:00",
"is_enabled": true,
"recurrent_schedule": null,
"is_always_visible": false,
"attribute_conditions": [
{
"attribute": "race",
"operator": "eq",
"value": "elf",
"type": "string",
"can_be_missing": false
},
{
"attribute": "level",
"operator": "ge",
"value": "10",
"type": "number",
"can_be_missing": false
},
{
"attribute": "10_level_up_date",
"operator": "le",
"value": "2026-01-01T00:00:00",
"type": "date",
"can_be_missing": false
}
]
},
{
"id": 4,
"name": {
"en": "Weekly offer chain",
"ru": "Еженедельная цепочка предложений",
"de": "Wöchentliche Angebotskette",
"fr": "Chaîne d'offres hebdomadaire",
"it": "Catena di offerte settimanale"
},
"description": {
"en": "Offer chain that resets weekly on Wednesdays at 07:00 GMT+3",
"ru": "Цепочка предложений, которая сбрасывается еженедельно по средам в 07:00 GMT+3",
"de": "Angebotskette, die sich wöchentlich mittwochs um 07:00 Uhr GMT+3 zurücksetzt",
"fr": "Chaîne d'offres qui se réinitialise chaque semaine le mercredi à 07h00 GMT+3",
"it": "Catena di offerte che si resetta settimanalmente il mercoledì alle 07:00 GMT+3"
},
"order": 3,
"date_start": "2023-04-15T18:16:00+05:00",
"date_end": "2025-04-25T18:16:00+05:00",
"is_enabled": false,
"recurrent_schedule": {
"interval_type": "weekly",
"day_of_week": 3,
"time": "07:00:00+03:00",
"displayable_reset_start_date": "2018-12-05T07:00:00+03:00",
"displayable_reset_next_date": "2018-12-05T07:00:00+03:00",
"reset_next_date": 1543982400
},
"is_always_visible": true
},
{
"id": 5,
"name": {
"en": "Monthly offer chain",
"ru": "Ежемесячная цепочка предложений",
"de": "Monatliche Angebotskette",
"fr": "Chaîne d'offres mensuelle",
"it": "Catena di offerte mensile"
},
"description": {
"en": "Offer chain that resets monthly on the 28th at 15:00 GMT+8",
"ru": "Цепочка предложений, которая сбрасывается ежемесячно 28-го числа в 15:00 GMT+8",
"de": "Angebotskette, die sich monatlich am 28. um 15:00 Uhr GMT+8 zurücksetzt",
"fr": "Chaîne d'offres qui se réinitialise mensuellement le 28 à 15h00 GMT+8",
"it": "Catena di offerte che si resetta mensilmente il 28 alle 15:00 GMT+8"
},
"order": 4,
"date_start": "2025-04-15T00:00:00+08:00",
"date_end": "2025-08-28T15:00:00+08:00",
"is_enabled": true,
"recurrent_schedule": {
"interval_type": "monthly",
"day_of_month": 28,
"time": "15:00:00+08:00",
"displayable_reset_start_date": "2025-05-28T15:00:00+08:00",
"displayable_reset_next_date": "2025-05-28T15:00:00+08:00",
"reset_next_date": 1748415600
},
"is_always_visible": true
}
]
}
},
"422-admin-offer-chain-error-too-many-steps": {
"summary": "Too many steps",
"description": "The number of offer chain steps exceeds the allowed limit of 30. Try specifying fewer steps.",
"value": {
"statusCode": 422,
"errorCode": 6203,
"errorMessage": "[0401-6203]: Chain step count exceeds the allowed limit",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 0,
"step_count": 31,
"max_steps": 30
}
}
},
"422-admin-offer-chain-error-incorrect-steps-order": {
"summary": "Invalid steps order",
"description": "The sequence of offer chain step numbers is incorrect. Step numbers must be sequential, without gaps or duplicates.",
"value": {
"statusCode": 422,
"errorCode": 6210,
"errorMessage": "[0401-6210]: Chain step numbers are invalid",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 0,
"incorrect_step_numbers": {
"duplicates": [
2,
7
],
"out_of_range": [
7,
8
],
"missing": [
3,
4,
5,
6
]
}
}
}
},
"422-admin-offer-chain-error-item-limit-exceeded": {
"summary": "Item limit exceeded",
"description": "The number of items in one or more offer chain steps exceeds the allowed limit. Currently, only one item per step is allowed.",
"value": {
"statusCode": 422,
"errorCode": 6208,
"errorMessage": "[0401-6208]: Chain step item count exceeds the allowed limit for some steps",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 0,
"max_items": 1,
"steps_exceeded_limits": [
{
"step_number": 1,
"items_count": 2
},
{
"step_number": 4,
"items_count": 3
}
]
}
}
},
"422-admin-offer-chain-error-incorrect-items": {
"summary": "Invalid step items",
"description": "Specified items are either unavailable, or not found. Only enabled items of the following types are supported: virtual items, bundles, and virtual currency packages.",
"value": {
"statusCode": 422,
"errorCode": 6211,
"errorMessage": "[0401-6211]: Chain steps items are not allowed or not found",
"transactionId": "x-x-xX-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 0,
"invalid_items": {
"not_found": [
"vg_deleted_item_1",
"vg_deleted_item_2",
"not_existing_sku_404_1",
"not_existing_sku_404_2"
],
"disabled": [
"vg_disabled_item_1",
"vg_disabled_item_2",
"vc_disabled_1"
],
"invalid_item_type": {
"allowed_item_type_list": [
"virtual_good",
"bundle"
],
"sku_map": {
"vc_enabled_shown_in_store_1": "virtual_currency",
"vc_disabled_1": "virtual_currency",
"unit_enabled_shown_in_store_1": "unit",
"gk_steam_enabled_shown_in_store_1": "game_key"
}
}
}
}
}
},
"422-admin-offer-chain-error-invalid-dates": {
"summary": "Invalid date format",
"description": "The date format must be valid. Use ISO 8601 format.",
"value": {
"statusCode": 422,
"errorCode": 6204,
"errorMessage": "[0401-6204]: Period of a chain is invalid. Please, check the dates in your request",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 0,
"chain_id": 1,
"invalid_format_dates": {
"date_start": "2023-04-15 17:16:00Z",
"date_end": "2025-04-25 19:16:00Z"
}
}
}
},
"422-admin-offer-chain-error-incorrect-period": {
"summary": "Invalid chain period",
"description": "The start date must be earlier than the end date.",
"value": {
"statusCode": 422,
"errorCode": 6204,
"errorMessage": "[0401-6204]: Period of a chain is invalid. Please, check the dates in your request",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 0,
"chain_id": 1,
"invalid_periods": [
{
"start": "2025-04-25T18:16:00+05:00",
"end": "2023-04-15T18:16:00+05:00"
}
]
}
}
},
"200-admin-offer-chain": {
"summary": "Offer chain example",
"value": {
"id": 3,
"name": {
"en": "Offer chain",
"ru": "Цепочка",
"de": "Angebotskette",
"fr": "Chaîne d'offres",
"it": "Catena di offerte"
},
"description": {
"en": "Personalized offer chain with user attribute conditions - for level 10 and above elves who reached level 10 no later than 2026-01-01 00:00:00, inclusive",
"ru": "Персонализированная цепочка предложений - для эльфов 10 уровня и выше, достигших 10 уровня не позднее 2026-01-01 00:00:00 включительно",
"de": "Personalisierte Angebotskette mit Benutzerattributbedingungen - für Elfen der Stufe 10 und höher, die Stufe 10 spätestens am 2026-01-01 00:00:00 erreicht haben, einschließlich",
"fr": "Chaîne d'offres personnalisée avec des conditions d'attribut utilisateur - pour les elfes de niveau 10 et plus qui ont atteint le niveau 10 au plus tard le 2026-01-01 00:00:00, inclus",
"it": "Catena di offerte personalizzata con condizioni di attributo utente - per elfi di livello 10 e superiore che hanno raggiunto il livello 10 non più tardi del 2026-01-01 00:00:00, inclusi"
},
"date_start": "2023-04-15T18:16:00+05:00",
"date_end": "2025-04-25T18:16:00+05:00",
"order": 1,
"recurrent_schedule": null,
"steps": [
{
"step_id": 7,
"step_number": 1,
"is_free": false,
"items": [
{
"item_id": 9010,
"sku": "telescope",
"name": {
"en": "Telescope",
"ru": "Телескоп",
"de": "Teleskop",
"fr": "Télescope",
"it": "Telescopio"
},
"type": "virtual_good",
"description": {
"en": "Allows to see the stars",
"ru": "Позволяет увидеть звезды",
"de": "Ermöglicht das Betrachten der Sterne",
"fr": "Permet de voir les étoiles",
"it": "Permette di vedere le stelle"
},
"image_url": "https://cdn.picture.vg.sku-telescope.png",
"quantity": 1,
"order": 1
},
{
"item_id": 9012,
"sku": "health_potion",
"name": {
"en": "Healing potion",
"ru": "Зелье лечения",
"de": "Heiltrank",
"fr": "Potion de soin",
"it": "Pozione curativa"
},
"type": "virtual_good",
"description": {
"en": "Heal 10% of your health",
"ru": "Лечит 10% здоровья",
"de": "Heilt 10% deiner Gesundheit",
"fr": "Soigne 10% de votre santé",
"it": "Cura il 10% della tua salute"
},
"image_url": "https://cdn.picture/vg-sku-health_potion.png",
"quantity": 2,
"order": 0
}
]
},
{
"step_id": 6,
"step_number": 2,
"is_free": false,
"items": [
{
"item_id": 9010,
"sku": "telescope",
"name": {
"en": "Telescope",
"ru": "Телескоп",
"de": "Teleskop",
"fr": "Télescope",
"it": "Telescopio"
},
"type": "virtual_good",
"description": {
"en": "Allows to see the stars",
"ru": "Позволяет увидеть звезды",
"de": "Ermöglicht das Betrachten der Sterne",
"fr": "Permet de voir les étoiles",
"it": "Permette di vedere le stelle"
},
"image_url": "https://cdn.picture/vg-sku-telescope.png",
"quantity": 5,
"order": 0
}
]
},
{
"step_id": 5,
"step_number": 3,
"is_free": true,
"items": [
{
"item_id": 9010,
"sku": "telescope",
"name": {
"en": "Telescope",
"ru": "Телескоп",
"de": "Teleskop",
"fr": "Télescope",
"it": "Telescopio"
},
"type": "virtual_good",
"description": {
"en": "Allows to see the stars",
"ru": "Позволяет увидеть звезды",
"de": "Ermöglicht das Betrachten der Sterne",
"fr": "Permet de voir les étoiles",
"it": "Permette di vedere le stelle"
},
"image_url": "https://cdn.picture/vg-sku-telescope.png",
"quantity": 2,
"order": 0
}
]
}
],
"is_enabled": true,
"is_always_visible": false,
"attribute_conditions": [
{
"attribute": "race",
"operator": "eq",
"value": "elf",
"type": "string",
"can_be_missing": false
},
{
"attribute": "level",
"operator": "ge",
"value": "10",
"type": "number",
"can_be_missing": false
},
{
"attribute": "10_level_up_date",
"operator": "le",
"value": "2026-01-01T00:00:00",
"type": "date",
"can_be_missing": false
}
]
}
},
"422-admin-offer-chain-error-invalid-chain-step-ids": {
"summary": "Chain step IDs not found",
"description": "Some of the step IDs were not found. Double-check that the specified chain step IDs exist. To do this, use the Get offer chain call.",
"value": {
"statusCode": 404,
"errorCode": 6206,
"errorMessage": "[0401-6206]: Chain step IDs not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 0,
"chain_id": 1,
"chain_step_id_list": [
404000
]
}
}
},
"422-admin-offer-chain-error-chain-id-mismatch": {
"summary": "Chain ID mismatch",
"description": "Offer chain ID in the request body does not match the ID in the URL.",
"value": {
"statusCode": 422,
"errorCode": 6205,
"errorMessage": "[0401-6205]: Chain ID mismatch. Please, check the chain ID in your request body and URL",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 0,
"url_chain_id": 1,
"body_chain_id": 2
}
}
},
"422-admin-offer-chain-error-duplicate-step-ids": {
"summary": "Duplicate chain step IDs",
"description": "Chain step IDs must be unique in the request body.",
"value": {
"statusCode": 422,
"errorCode": 6207,
"errorMessage": "[0401-6207]: Duplicate chain step IDs detected in the request body",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 0,
"chain_step_id_list": [
8,
9,
10
],
"chain_id": 3
}
}
},
"422-admin-offer-chain-error-activated": {
"summary": "Active offer chain cannot be updated",
"description": "Active offer chain has to be deactivated before being updated. To do this, use the Toggle offer chain call.",
"value": {
"statusCode": 422,
"errorCode": 6209,
"errorMessage": "[0401-6209]: Active chain cannot be updated. Please deactivate it first",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 0,
"chain_id": 2
}
}
}
},
"responses": {
"Promotions_200-get-promotions": {
"description": "Список акций успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"promotions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Promotions_200-get-promotion-model"
}
},
"total_promotions_count": {
"$ref": "#/components/schemas/total_promotions_count"
},
"active_promotions_count": {
"$ref": "#/components/schemas/active_promotions_count"
},
"inactive_promotions_count": {
"$ref": "#/components/schemas/inactive_promotions_count"
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/Promotions_200-admin-promotions"
}
}
}
}
},
"Promotions_401-invalid-basic-auth": {
"description": "Данные для базовой аутентификации не переданы или ошибочны. Убедитесь, что использовали базовую аутентификацию, и проверьте правильность учетных данных.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1020
},
"errorMessage": {
"type": "string",
"example": "[0401-1020]: Error in Authentication method occurred"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred"
}
}
}
}
}
},
"Promotions_422-activate-deactivate-promotion": {
"description": "Неверный запрос.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0401-9505]: Error was occurred while promotion was being updated"
},
"transactionId": {
"type": "string",
"example": "da145238620011eb8e24fe6913ff226a"
}
}
},
"examples": {
"Error was occurred": {
"$ref": "#/components/examples/422-activate-deactivate-promotion"
}
}
}
}
},
"200-admin-get-redeemable-by-code": {
"description": "Акция успешно получена.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/admin-promotions_200-get-redeemable-coupon-promotion-model"
},
"examples": {
"Promo Code Response": {
"value": {
"promotion_periods": [
{
"date_from": "2023-05-01T01:00:00+05:00",
"date_until": "2023-05-31T23:59:59+05:00"
},
{
"date_from": "2023-06-01T01:00:00+05:00",
"date_until": "2023-06-30T23:59:59+05:00"
}
],
"bonus": [],
"is_enabled": true,
"external_id": "falls2023",
"name": {
"ru": "Скидка по промокоду на Epic Fall Hammer",
"en": "Promo Code discount for Epic Fall Hammer"
},
"redeem_total_limit": 2,
"redeem_user_limit": 3,
"redeem_code_limit": null,
"total_limit_state": {
"available": 1,
"reserved": 1,
"used": 0
},
"discount": {
"percent": null
},
"discounted_items": [
{
"sku": "epic_fall_hammer_1",
"discount": {
"percent": "20.00"
}
}
]
}
},
"Coupon Response": {
"value": {
"promotion_periods": [
{
"date_from": "2023-04-15T01:00:00+05:00",
"date_until": "2023-04-30T23:59:59+05:00"
},
{
"date_from": "2023-05-15T01:00:00+05:00",
"date_until": "2023-05-30T23:59:59+05:00"
}
],
"bonus": [
{
"sku": "epic_fall_hammer_1",
"quantity": 3
}
],
"is_enabled": true,
"external_id": "coupon_fall_hammer_2",
"name": {
"en": "This is a Coupon code for Epic Fall Hammer",
"ru": "Eto kod kupona на Epic Fall Hammer"
},
"redeem_total_limit": 99,
"redeem_user_limit": 1,
"redeem_code_limit": null
}
}
}
}
}
},
"401-invalid-basic-auth": {
"description": "Данные для базовой аутентификации не переданы или ошибочны. Убедитесь, что использовали базовую аутентификацию, и проверьте правильность учетных данных.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1020
},
"errorMessage": {
"type": "string",
"example": "[0401-1020]: Error in Authentication method occurred"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred"
}
}
}
}
}
},
"404-code-not-found": {
"description": "Код не найден. Убедитесь, что указанное значение кода является правильным.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 9811
},
"errorMessage": {
"type": "string",
"example": "[0401-9811]: Code not found."
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 9811,
"errorMessage": "[0401-9811]: Code not found."
}
}
}
}
}
},
"405-method-not-found": {
"description": "Неправильный формат кода. Код может содержать только буквы и цифры.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 405
},
"errorCode": {
"type": "integer",
"example": 0
},
"errorMessage": {
"type": "string",
"example": "Method is not allowed. Method must be one of: OPTIONS"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 405,
"errorCode": 0,
"errorMessage": "Method is not allowed. Method must be one of: OPTIONS"
}
}
}
}
}
},
"Promotions_200-coupon-redeemed": {
"description": "Купон успешно погашен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"name": {
"type": [
"string",
"null"
]
},
"price": {
"type": [
"object",
"null"
],
"description": "Цены на товар.",
"properties": {
"amount": {
"type": "string",
"example": "2.9900",
"description": "Цена товара со скидкой."
},
"amount_without_discount": {
"type": "string",
"example": "2.9900",
"description": "Цена товара."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Валюта, в которой указана цена товара. Трехбуквенный код в соответствии со стандартом [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
}
}
},
"type": {
"type": "string"
},
"virtual_item_type": {
"type": "string",
"example": "non-consumable",
"description": "Тип виртуального предмета.\n\nВозможные значения:\n- `consumable` — предмет, исчезающий из инвентаря после использования (например, патроны).\n- `non_consumable` — предмет, остающийся в инвентаре в течение неограниченного времени.\n- `non_renewing_subscription` — предмет с ограниченным сроком действия, который может служить представлением доступа к сервисам или контенту в течение ограниченного периода времени.",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
]
},
"virtual_prices": {
"type": "array"
},
"description": {
"type": "string"
},
"image_url": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"is_free": {
"type": "boolean"
},
"attributes": {
"type": "array"
}
}
},
"example": [
{
"attributes": [],
"description": "Take it, take it all! All of Xsolla's riches in one Mega Booster.",
"groups": [
{
"external_id": "powerups",
"name": "Power Ups"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": false,
"name": "Xsolla Booster Mega",
"price": {
"amount": "50.0000000000000000",
"amount_without_discount": "100.0000000000000000",
"currency": "USD"
},
"quantity": 1,
"sku": "com.xsolla.booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": []
}
]
}
}
},
"examples": {
"response": {
"value": {
"items": [
{
"attributes": [],
"description": "Take it, take it all! All of Xsolla's riches in one Mega Booster.",
"groups": [
{
"external_id": "powerups",
"name": "Power Ups"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": true,
"name": "Xsolla Booster Mega",
"price": null,
"quantity": 1,
"sku": "com.xsolla.booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": []
}
]
}
}
}
}
}
},
"Promotions_401-invalid-client-auth": {
"description": "Данные для аутентификации не переданы или ошибочны.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1501
},
"errorMessage": {
"type": "string",
"example": "[0401-1501]: Authorization failed: Provide authorization"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1501,
"errorMessage": "[0401-1501]: Authorization failed: Provide authorization"
}
}
}
}
}
},
"Promotions_403-auth-header": {
"description": "Заголовок Authorization не отправлен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 403
},
"errorCode": {
"type": "integer",
"example": 0
},
"errorMessage": {
"type": "string",
"example": "Authorization header not sent."
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 403,
"errorCode": 0,
"errorMessage": "Authorization header not sent"
}
}
}
}
}
},
"Promotions_404-coupon": {
"description": "Введите действительный код купона.",
"content": {
"application/json": {
"schema": {
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-9807]: Enter valid coupon code."
}
},
"type": "object"
}
}
}
},
"Promotions_422-redeem-coupon": {
"description": "Неверный запрос.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0401-1102]: Unprocessable Entity. The property `coupon_code` is required"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `coupon_code` is required"
}
}
}
}
}
},
"Promotions_200-coupon-rewards": {
"description": "Список вознаграждений по купону успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"bonus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Promotions_200-coupon-bonus-reward"
}
},
"is_selectable": {
"type": "boolean",
"description": "Если `true`, то пользователь должен выбрать бонус перед погашением купона."
},
"discount": {
"$ref": "#/components/schemas/Promotions_200-coupon-discount-reward"
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/Promotions_200-get-coupon-rewards"
}
}
}
}
},
"Promotions_422-rewards": {
"description": "Неверный запрос.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Promotions_422_limit_error"
},
{
"$ref": "#/components/schemas/Promotions_422_reglock_error"
}
]
}
}
}
},
"Promotions_200-get-coupons": {
"description": "Список купонов успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/admin-promotions_200-get-coupon-promotion-model"
}
},
"total_promotions_count": {
"$ref": "#/components/schemas/total_promotions_count"
},
"active_promotions_count": {
"$ref": "#/components/schemas/active_promotions_count"
},
"inactive_promotions_count": {
"$ref": "#/components/schemas/inactive_promotions_count"
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/Promotions_200-admin-coupons"
}
}
}
}
},
"Promotions_422-invalid-coupon": {
"description": "Неверный запрос.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0401-1102]: Unprocessable Entity. The property `external_id` is required"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `external_id` is required"
}
}
}
}
}
},
"Promotions_404-admin-coupon": {
"description": "Купон не найден. Убедитесь, что верно указали `external_id`.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-9802]: Coupon not found"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"Promotions_422-admin-promotion-error": {
"description": "Произошла ошибка при получении акции от сервиса продвижения.",
"content": {
"application/json": {
"schema": {
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 9502
},
"errorMessage": {
"type": "string",
"example": "[0401-9502]: Error occurred while receiving the promotion from the promotion service"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"type": "object"
}
}
}
},
"Promotions_200-coupon-code-list": {
"description": "Список кодов для купона успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"codes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"$ref": "#/components/schemas/Promotions_coupon_code"
}
}
}
},
"total_count": {
"type": "number",
"description": "Общее количество кодов для купона."
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/Promotions_200-coupon-code-list"
}
}
}
}
},
"Promotions_201-coupon-promocode-code-created": {
"description": "Код успешно создан.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"$ref": "#/components/schemas/Promotions_coupon_code"
}
}
},
"examples": {
"response": {
"value": {
"code": "WINTER2021"
}
}
}
}
}
},
"Promotions_422-coupon-promocode-same-code-exists": {
"description": "Неверный запрос. Код уже существует.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 9803
},
"errorMessage": {
"type": "string",
"example": "[0401-9803]: The code already exists."
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 422,
"errorCode": 9803,
"errorMessage": "[0401-9803]: The code already exists.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"Promotions_404-admin-promocode": {
"description": "Промокод не найден. Убедитесь, что `external_id` указан правильно.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-9802]: Promocode not found"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"Promotions_200-promo-code-redeemed": {
"description": "Промокод успешно погашен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cart_id": {
"type": "string",
"example": "cart_id",
"description": "ID корзины."
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string",
"example": "50.0000000000000000"
},
"amount_without_discount": {
"type": "string",
"example": "100.0000000000000000"
},
"currency": {
"type": "string",
"example": "USD"
}
},
"example": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"description": "Цена корзины."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"name": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"image_url": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
},
"loyalty_rewards": {
"$ref": "#/components/schemas/item-loyalty-point-reward"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
}
}
},
"example": [
{
"attributes": [],
"description": "Take it, take it all! All of Xsolla's riches in one Mega Booster.",
"groups": [
{
"external_id": "powerups",
"name": "Power Ups"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": false,
"name": "Xsolla Booster Mega",
"price": {
"amount": "50.0000000000000000",
"amount_without_discount": "100.0000000000000000",
"currency": "USD"
},
"quantity": 123,
"sku": "com.xsolla.booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": [],
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"can_be_bought": true,
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": false
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"limits": {
"per_user": {
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
]
},
"rewards": {
"$ref": "#/components/schemas/Promo_code_rewards"
}
}
},
"examples": {
"response": {
"value": {
"cart_id": "cart_id",
"is_free": false,
"items": [
{
"attributes": [],
"description": "Take it, take it all! All of Xsolla's riches in one Mega Booster.",
"groups": [
{
"external_id": "powerups",
"name": "Power Ups"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": false,
"name": "Xsolla Booster Mega",
"price": {
"amount": "50.0000000000000000",
"amount_without_discount": "100.0000000000000000",
"currency": "USD"
},
"quantity": 123,
"sku": "com.xsolla.booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": [],
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"can_be_bought": true,
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": false
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"loyalty_rewards": [
{
"name": "Gold Coin",
"sku": "f752ecb0-e684-4071-8397-2aba694983e1",
"description": "These are rebate coins that can be used to purchase items in the store.",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"amount": 50
}
],
"limits": {
"per_user": {
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"attributes": [],
"description": "Honshu Boshin Wakizashi - Modern Tactical Samurai / Ninja Sword - Hand Forged 1060 Carbon Steel - Full Tang, Fully Functional, Battle Ready - Black TPR, Steel Guard and Pommel.",
"groups": [],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": true,
"name": "Sword Xsolla Skin",
"price": [],
"quantity": 1,
"sku": "com.xsolla.swords_1",
"type": "virtual_good",
"virtual_item_type": "non_consumable",
"virtual_prices": [],
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"can_be_bought": true,
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"loyalty_rewards": [
{
"name": "Gold Coin",
"sku": "f752ecb0-e684-4071-8397-2aba694983e1",
"description": "These are rebate coins that can be used to purchase items in the store.",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"amount": 50
}
],
"limits": {
"per_user": {
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
],
"price": {
"amount": "6150.0000000000000000",
"amount_without_discount": "12300.0000000000000000",
"currency": "USD"
},
"rewards": {
"bonus": [
{
"item": {
"name": "Sword Xsolla Skin",
"sku": "com.xsolla.swords_1",
"type": "virtual_good",
"virtual_item_type": "non_consumable",
"description": "Honshu Boshin Wakizashi - Modern Tactical Samurai / Ninja Sword - Hand Forged 1060 Carbon Steel - Full Tang, Fully Functional, Battle Ready - Black TPR, Steel Guard and Pommel.",
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png"
},
"quantity": 1
}
],
"discount": {
"percent": null
},
"discounted_items": [
{
"sku": "com.xsolla.booster_mega_1",
"discount": {
"percent": "50.00"
}
}
],
"is_selectable": false
}
}
}
}
}
}
},
"Promotions_404-promo-code": {
"description": "Введите действительный промокод.",
"content": {
"application/json": {
"schema": {
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-9807]: Enter valid promo code."
}
},
"type": "object"
}
}
}
},
"Promotions_200-promo-code-canceled": {
"description": "Промокод успешно отменен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cart_id": {
"type": "string",
"example": "cart_id",
"description": "ID корзины."
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string",
"default": "50.0000000000000000"
},
"amount_without_discount": {
"type": "string",
"default": "100.0000000000000000"
},
"currency": {
"type": "string",
"default": "USD"
}
},
"example": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"description": "Цена корзины."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"name": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string"
},
"virtual_item_type": {
"type": "string",
"example": "non-consumable",
"description": "Тип виртуального предмета.\n\nВозможные значения:\n- `consumable` — предмет, исчезающий из инвентаря после использования (например, патроны).\n- `non_consumable` — предмет, остающийся в инвентаре в течение неограниченного времени.\n- `non_renewing_subscription` — предмет с ограниченным сроком действия, который может служить представлением доступа к сервисам или контенту в течение ограниченного периода времени.",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
]
},
"virtual_prices": {
"type": "array"
},
"description": {
"type": "string"
},
"attributes": {
"$ref": "#/components/schemas/client-attributes"
},
"image_url": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": [
"object",
"null"
],
"description": "Цены на товар.",
"properties": {
"amount": {
"type": "string",
"example": "2.9900",
"description": "Цена товара со скидкой."
},
"amount_without_discount": {
"type": "string",
"example": "2.9900",
"description": "Цена товара."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Валюта, в которой указана цена товара. Трехбуквенный код в соответствии со стандартом [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
}
}
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
}
}
},
"example": [
{
"attributes": [],
"description": "Take it, take it all! All of Xsolla's riches in one Mega Booster.",
"groups": [
{
"external_id": "powerups",
"name": "Power Ups"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": false,
"name": "Xsolla Booster Mega",
"price": {
"amount": "50.0000000000000000",
"amount_without_discount": "100.0000000000000000",
"currency": "USD"
},
"quantity": 123,
"sku": "com.xsolla.booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": [],
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"can_be_bought": true,
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"limits": {
"per_user": {
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
]
}
}
},
"examples": {
"response": {
"value": {
"cart_id": "cart_id",
"is_free": false,
"items": [
{
"attributes": [],
"description": "Take it, take it all! All of Xsolla's riches in one Mega Booster.",
"groups": [
{
"external_id": "powerups",
"name": "Power Ups"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": false,
"name": "Xsolla Booster Mega",
"price": {
"amount": "50.0000000000000000",
"amount_without_discount": "100.0000000000000000",
"currency": "USD"
},
"quantity": 123,
"sku": "com.xsolla.booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": [],
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"can_be_bought": true,
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"limits": {
"per_user": {
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
],
"price": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
}
}
}
}
}
}
},
"Promotions_422-cancel-promo-code": {
"description": "Неверный запрос.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0401-1102]: Unprocessable Entity. The property `id` is required"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `id` is required"
}
}
}
}
}
},
"Promotions_200-promocode-rewards": {
"description": "Список вознаграждений по промокоду успешно получен.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Promo_code_rewards"
},
"examples": {
"response": {
"$ref": "#/components/examples/Promotions_200-get-promocode-rewards"
}
}
}
}
},
"Promotions_200-get-promocodes": {
"description": "Список промокодов успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Promotions_200-get-promocode-promotion-model"
}
},
"total_promotions_count": {
"$ref": "#/components/schemas/total_promotions_count"
},
"active_promotions_count": {
"$ref": "#/components/schemas/active_promotions_count"
},
"inactive_promotions_count": {
"$ref": "#/components/schemas/inactive_promotions_count"
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/Promotions_200-admin-promocodes"
}
}
}
}
},
"Promotions_200-promocode-code-list": {
"description": "Список кодов для промокода успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"codes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"$ref": "#/components/schemas/Promotions_coupon_code"
}
}
}
},
"total_count": {
"type": "number",
"description": "Общее количество кодов для промокода."
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/Promotions_200-coupon-code-list"
}
}
}
}
},
"Promotions_200-get-item-promotions": {
"description": "Список акций со скидками успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"promotions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID акции. Уникальный идентификатор акции в рамках проекта."
},
"promotion_periods": {
"$ref": "#/components/schemas/promotion_periods"
},
"is_enabled": {
"$ref": "#/components/schemas/Promotions_is_enabled"
},
"name": {
"type": "object",
"description": "Название акции. Данный параметр должен содержать пары ключ/значение, где ключ — это локаль в формате \"^[a-z]{2}-[A-Z]{2}$\", значение — строка.",
"additionalProperties": {
"type": "string"
},
"example": {
"en-US": "Promotion",
"ru-RU": "Акция"
}
},
"discount": {
"type": "object",
"properties": {
"percent": {
"type": [
"string",
"null"
],
"description": "Процент скидки.\nЦена товара будет уменьшена с использованием значения, рассчитанного с использованием этого процента.",
"default": "10.00"
}
}
},
"items": {
"type": [
"array",
"null"
],
"items": {
"description": "Список товаров, на которые будет распространяться скидка.",
"type": "object",
"properties": {
"sku": {
"type": [
"string",
"null"
],
"description": "Артикул товара.",
"default": "elven_sword"
}
}
}
},
"attribute_conditions": {
"$ref": "#/components/schemas/promotion_user-attribute_conditions_model-get"
},
"limits": {
"$ref": "#/components/schemas/Promotions_promotion_limits_response"
},
"excluded_promotions": {
"$ref": "#/components/schemas/excluded_promotions"
},
"price_conditions": {
"$ref": "#/components/schemas/price_conditions_discount"
}
}
}
},
"total_promotions_count": {
"$ref": "#/components/schemas/total_promotions_count"
},
"active_promotions_count": {
"$ref": "#/components/schemas/active_promotions_count"
},
"inactive_promotions_count": {
"$ref": "#/components/schemas/inactive_promotions_count"
}
}
},
"examples": {
"response": {
"value": {
"promotions": [
{
"id": 1,
"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"
}
],
"is_enabled": true,
"discount": {
"percent": "20.00"
},
"items": [
{
"sku": "com.xsolla.elven_sword_1"
}
],
"name": {
"en-US": "Promotion",
"ru-RU": "Акция"
},
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
}
},
{
"id": 2,
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"is_enabled": true,
"discount": {
"percent": "10.00"
},
"items": [
{
"sku": "com.xsolla.elven_helmet_1"
},
{
"sku": "com.xsolla.elven_armor_1"
}
],
"name": {
"en-US": "Promotion",
"ru-RU": "Акция"
},
"limits": {
"per_user": {
"total": 10
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"excluded_promotions": [
1,
3
]
},
{
"id": 3,
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"is_enabled": true,
"discount": {
"percent": "10.00"
},
"items": [
{
"sku": "com.xsolla.elven_helmet_2"
},
{
"sku": "com.xsolla.elven_armor_2"
}
],
"name": {
"en-US": "Promotion",
"ru-RU": "Акция"
},
"limits": {
"per_user": {
"total": 10
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"price_conditions": [
{
"operator": "gt",
"value": "10.0000"
},
{
"operator": "lt",
"value": "20.0000"
}
]
},
{
"id": 4,
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"is_enabled": true,
"discount": {
"percent": "10.00"
},
"items": null,
"name": {
"en-US": "Promotion",
"ru-RU": "Акция"
},
"limits": {
"per_user": {
"total": 10
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"price_conditions": [
{
"operator": "lt",
"value": "20.0000"
}
]
}
],
"total_promotions_count": 4,
"active_promotions_count": 4,
"inactive_promotions_count": 0
}
}
}
}
}
},
"Promotions_201-create-promotion": {
"description": "Акция успешно создана.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"promotion_id": {
"type": "integer",
"description": "ID акции. Уникальный идентификатор акции в рамках проекта."
}
}
},
"examples": {
"response": {
"value": {
"promotion_id": 2384756
}
}
}
}
}
},
"Promotions_422-admin-promotion-missed-items-property": {
"description": "Неверный запрос.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0401-1102]: Unprocessable Entity. The property `items` is required"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `items` is required",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"Promotions_404-admin-promotion": {
"description": "Акция не найдена. Убедитесь, что верно указали `promotion_id`.",
"content": {
"application/json": {
"schema": {
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 9502
},
"errorMessage": {
"type": "string",
"example": "[0401-9502]: Can not find promotion with ID = 111425 in project 59080"
}
},
"type": "object"
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 9502,
"errorMessage": "[0401-9502]: Can not find promotion with ID = 111425 in project 59080"
}
}
}
}
}
},
"Promotions_200-get-bonus-promotions": {
"description": "Список акций с бонусами успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"promotions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Promotions_200-get-bonus-promotion-model"
}
},
"total_promotions_count": {
"$ref": "#/components/schemas/total_promotions_count"
},
"active_promotions_count": {
"$ref": "#/components/schemas/active_promotions_count"
},
"inactive_promotions_count": {
"$ref": "#/components/schemas/inactive_promotions_count"
}
}
},
"examples": {
"response": {
"value": {
"promotions": [
{
"id": 1,
"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 Bonus",
"de-DE": "Neujahrsbonus"
},
"is_enabled": true,
"condition": [
{
"sku": "com.xsolla.elven_boots_1"
},
{
"sku": "com.xsolla.elven_knife_1"
}
],
"bonus": [
{
"sku": "com.xsolla.elven_sword_1",
"quantity": 1
},
{
"sku": "com.xsolla.elven_shield_1",
"quantity": 2
},
{
"sku": "com.xsolla.elven_gloves_1",
"quantity": 2
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
}
},
{
"id": 2,
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"name": {
"en-US": "Summer season bonus",
"de-DE": "Sommersaison Bonus"
},
"is_enabled": true,
"condition": null,
"bonus": [
{
"sku": "com.xsolla.diamonds_1",
"quantity": 100
}
],
"limits": {
"per_user": {
"total": 10
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"price_conditions": [
{
"operator": "gt",
"value": "10.0000"
},
{
"operator": "lt",
"value": "50.0000"
}
],
"excluded_promotions": [
1
]
}
],
"total_promotions_count": 2,
"active_promotions_count": 2,
"inactive_promotions_count": 0
}
}
}
}
}
},
"Promotions_422-admin-promotion-missed-bonus-property": {
"description": "Неверный запрос.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0401-1102]: Unprocessable Entity. The property `bonus` is required"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `bonus` is required",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"Promotions_200-admin-get-bonus-promotion": {
"description": "Акция с бонусами успешно получена.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Promotions_200-get-bonus-promotion-model"
},
"examples": {
"response": {
"value": {
"id": 1,
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"name": {
"en-US": "New Year Bonus",
"de-DE": "Neujahrsbonus"
},
"is_enabled": true,
"condition": [
{
"sku": "com.xsolla.elven_boots_1"
},
{
"sku": "com.xsolla.elven_knife_1"
}
],
"bonus": [
{
"sku": "com.xsolla.elven_sword_1",
"quantity": 1
},
{
"sku": "com.xsolla.elven_shield_1",
"quantity": 2
},
{
"sku": "com.xsolla.elven_gloves_1",
"quantity": 2
}
],
"limits": {
"per_user": {
"total": 10
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"excluded_promotions": [
23,
45
],
"price_conditions": [
{
"operator": "gt",
"value": "10.0000"
},
{
"operator": "lt",
"value": "50.0000"
}
]
}
}
}
}
}
},
"Promotions_200-verify-promo-code": {
"description": "Информация о коде.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Тип кода: `promocode`/`coupon`."
},
"code": {
"$ref": "#/components/schemas/Promotions_coupon_code"
},
"rewards": {
"oneOf": [
{
"$ref": "#/components/schemas/Coupon_rewards"
},
{
"$ref": "#/components/schemas/Promo_code_rewards_verify"
}
]
}
}
},
"examples": {
"coupon info": {
"value": {
"type": "coupon",
"code": "WINTER2023",
"rewards": {
"bonus": [
{
"item": {
"sku": "com.xsolla.game_1",
"name": "Game name",
"type": "unit",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"unit_items": [
{
"sku": "com.xsolla.game_key_01",
"name": "Game name",
"type": "game_key",
"is_free": false,
"drm_name": "Steam",
"drm_sku": "steam_key_1"
},
{
"sku": "com.xsolla.game_key_02",
"name": "Game name",
"type": "game_key",
"drm_name": "Origin",
"drm_sku": "origin_key_1"
}
]
},
"quantity": 1
},
{
"item": {
"sku": "com.xsolla.game_2",
"name": "Game name",
"type": "unit",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"unit_items": [
{
"sku": "com.xsolla.game_key_01",
"type": "game_key",
"name": "Game name",
"drm_name": "Steam",
"drm_sku": "steam_key_1"
}
]
},
"quantity": 2
}
],
"is_selectable": true
}
}
},
"promocode info": {
"value": {
"type": "promocode",
"code": "SUMMER2023",
"rewards": {
"bonus": [
{
"item": {
"sku": "com.xsolla.game_2",
"name": "Game name",
"type": "unit",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"unit_items": [
{
"sku": "com.xsolla.game_key_01",
"type": "game_key",
"name": "Game name",
"drm_name": "Steam",
"drm_sku": "steam_key_1"
}
]
},
"quantity": 2
}
],
"discount": {
"percent": "10.00"
},
"discounted_items": [
{
"sku": "com.xsolla.elven_sword_1",
"name": "Elven sword",
"type": "virtual_good",
"description": "sword",
"image_url": null,
"discount": {
"percent": "10.00"
}
}
],
"is_selectable": true
}
}
}
}
}
}
},
"Promotions_404-verify-promo-code": {
"description": "Код не найден. Убедитесь, что указанное значение `code` является правильным.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 9811
},
"errorMessage": {
"type": "string",
"example": "[0401-9811]: Code not found."
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"Promotions_422-verify-promo-code": {
"description": "Код акции недействителен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer"
},
"statusCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
}
}
},
"examples": {
"code redemption limit": {
"value": {
"errorCode": 9804,
"statusCode": 422,
"errorMessage": "[0401-9804]: You have reached the coupon redemption limit."
}
},
"regionally restricted": {
"value": {
"errorCode": 9808,
"statusCode": 422,
"errorMessage": "[0401-9808]: Coupon is not available in your region."
}
}
}
}
}
},
"Promotions_200-get-unique-catalog-offers": {
"description": "Список купонов был успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Promotions_200-get-unique-catalog-offer-promotion-model"
}
},
"total_promotions_count": {
"$ref": "#/components/schemas/total_promotions_count"
},
"active_promotions_count": {
"$ref": "#/components/schemas/active_promotions_count"
},
"inactive_promotions_count": {
"$ref": "#/components/schemas/inactive_promotions_count"
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/Promotions_200-admin-unique-catalog-offers"
}
}
}
}
},
"Promotions_200-unique-catalog-offer-code-list": {
"description": "Список кодов для уникального предложения по каталогу был успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"codes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"$ref": "#/components/schemas/Promotions_coupon_code"
}
}
}
},
"total_count": {
"type": "number",
"description": "Общее количество уникальных кодов предложений по каталогу."
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/Promotions_200-coupon-code-list"
}
}
}
}
},
"200-admin-get-user-promo-code-limits": {
"description": "Успешно получены ограничения промокода для пользователей.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User-limit-promo-code"
},
"examples": {
"response": {
"value": {
"per_user": {
"total": 10,
"available": 9
}
}
}
}
}
}
},
"Common_401-invalid-basic-auth": {
"description": "Данные для базовой аутентификации не переданы или ошибочны. Убедитесь, что использовали базовую аутентификацию и проверьте правильность учетных данных.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1020
},
"errorMessage": {
"type": "string",
"example": "[0401-1020]: Error in Authentication method occurred"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred"
}
}
}
}
}
},
"200-admin-get-user-coupon-limits": {
"description": "Успешно получены ограничения купона для пользователя.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User-limit-coupon"
},
"examples": {
"response": {
"value": {
"per_user": {
"total": 10,
"available": 9
}
}
}
}
}
}
},
"200-admin-get-code-promo-code-limits": {
"description": "Успешно получены ограничения промокода.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"promotion_id": {
"type": "integer",
"description": "ID акции. Уникальный идентификатор акции в рамках проекта."
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Code-limit-promo-code"
}
},
"total_items_count": {
"type": "number",
"description": "Общее количество кодов."
},
"has_more": {
"type": "boolean",
"description": "Существует ли другая страница с кодами."
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/code-limit"
}
}
}
}
},
"200-admin-get-code-coupon-limits": {
"description": "Успешно получены ограничения купона.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"promotion_id": {
"type": "integer",
"description": "ID акции. Уникальный идентификатор акции в рамках проекта."
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Code-limit-promo-code"
}
},
"total_items_count": {
"type": "number",
"description": "Общее количество кодов."
},
"has_more": {
"type": "boolean",
"description": "Существует ли другая страница с кодами."
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/code-limit"
}
}
}
}
},
"Common_401-complex": {
"description": "Данные для аутентификации не переданы или ошибочны. Убедитесь, что использовали аутентификацию и проверьте правильность учетных данных.",
"content": {
"application/json": {
"schema": {
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1501
},
"errorMessage": {
"type": "string",
"example": "[0401-1501]: Authorization failed: Authorization header not sent"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"type": "object"
},
"examples": {
"Authorization header not sent": {
"$ref": "#/components/examples/401-complex-auth-header-not-found"
},
"Incorrect credentials": {
"$ref": "#/components/examples/401-complex-auth-incorrect-credentials"
}
}
}
}
},
"403-auth-header-not-sent": {
"description": "Заголовок Authorization не отправлен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 403
},
"errorCode": {
"type": "integer",
"example": 0
},
"errorMessage": {
"type": "string",
"example": "Authorization header not sent."
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 403,
"errorCode": 0,
"errorMessage": "Authorization header not sent"
}
}
}
}
}
},
"Common_422-body-validation": {
"description": "Ошибка валидации запроса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/422-invalid-request"
},
"examples": {
"response": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `name` is required",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
}
}
}
}
},
"200-admin-get-user-promotion-limits": {
"description": "Ограничения на продвижение для пользователя были успешно получены.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User-limit-promotion"
},
"examples": {
"response": {
"value": {
"per_user": {
"total": 10,
"available": 9
}
}
}
}
}
}
},
"200-admin-get-value-points": {
"description": "Список призовых баллов был успешно получен.",
"content": {
"application/json": {
"examples": {
"response": {
"$ref": "#/components/examples/200-value-points-reward-chain_admin_get-value-point-list"
}
},
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Value-points-item-model"
}
}
}
}
}
}
},
"201-admin-create-value-point": {
"description": "Призовые баллы были успешно созданы.",
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"sku": "com.xsolla.item_new",
"item_id": 10
}
}
},
"schema": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "new-sku"
},
"item_id": {
"type": "integer",
"example": 10
}
}
}
}
}
},
"422-admin-create-update-rc-vp-invalid-request": {
"description": "Неверный запрос.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/422-rc-vp-invalid-request"
},
"examples": {
"The property `sku` is required": {
"$ref": "#/components/examples/422-property-sku-is-required"
}
}
}
}
},
"200-admin-get-value-point": {
"description": "Указанные призовые баллы были успешно получены.",
"content": {
"application/json": {
"examples": {
"response": {
"$ref": "#/components/examples/200-value-points-reward-chain_admin_get-value-point"
}
},
"schema": {
"$ref": "#/components/schemas/Value-point-item-model"
}
}
}
},
"200-admin-get-list-value-point-rewards": {
"description": "Список товаров с призовыми баллами был успешно получен.",
"content": {
"application/json": {
"examples": {
"response": {
"$ref": "#/components/examples/200-value-points-rewards-list"
}
},
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/admin-item-value-point-reward"
}
}
}
}
}
}
},
"sellable-item-by-sku_404": {
"description": "Товар не найден. Убедитесь, что верно указали `project_id` и `sku`.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'electric_shiel' not found"
}
}
}
}
}
},
"200-client-get-reward-chains-list": {
"description": "Цепочка наград пользователя была успешно восстановлена.",
"content": {
"application/json": {
"examples": {
"response": {
"$ref": "#/components/examples/200-client-get-reward-chains-list"
}
},
"schema": {
"type": "object",
"properties": {
"has_more": {
"type": "boolean",
"example": true,
"description": "Используется как индикатор того, что остались еще страницы."
},
"total_items_count": {
"type": "integer",
"example": 10,
"description": "Общее количество цепочек наград в системе."
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/client-reward-chain-item-model"
}
}
}
}
}
}
},
"200-client-get-user-reward-chain-balance": {
"description": "Баланс призовых баллов пользователя был успешно восстановлен.",
"content": {
"application/json": {
"examples": {
"common": {
"$ref": "#/components/examples/200-client-get-user-reward-chain-balance"
},
"clan": {
"$ref": "#/components/examples/200-client-get-user-clan-reward-chain-balance"
}
},
"schema": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/value-point-sku"
},
"name": {
"$ref": "#/components/schemas/value-point-name"
},
"image_url": {
"$ref": "#/components/schemas/Common_admin-image_url"
},
"description": {
"$ref": "#/components/schemas/value-point-description"
},
"long_description": {
"$ref": "#/components/schemas/value-point-long-description"
},
"amount": {
"type": "integer",
"description": "Количество призовых баллов."
},
"is_clan": {
"$ref": "#/components/schemas/is_clan"
}
}
}
}
}
},
"404-reward-chain-step-not-found": {
"description": "Уровень цепочки наград не найден.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 9911
},
"errorMessage": {
"type": "string",
"example": "[0401-9911]: Reward chain step not found."
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 9911,
"errorMessage": "[0401-9911]: Reward chain step not found."
}
}
}
}
}
},
"422-reward-chain-step-reward-can-not-claimed": {
"description": "Невозможно получить награду на уровне цепочки наград.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 9912
},
"errorMessage": {
"type": "string",
"example": "[0401-9912]: Can't claim the step reward."
}
}
},
"examples": {
"Reward chain step reward already claimed": {
"value": {
"statusCode": 422,
"errorCode": 9912,
"errorMessage": "[0401-9912]: Reward already claimed."
}
},
"Not enough VP to claim reward chain step reward": {
"value": {
"statusCode": 422,
"errorCode": 9913,
"errorMessage": "[0401-9913]: Not enough value points to claim step reward."
}
}
}
}
}
},
"200-client-update-user-clan": {
"description": "Клан пользователя был успешно обновлен.",
"content": {
"application/json": {
"examples": {
"response": {
"$ref": "#/components/examples/200-client-update-user-clan"
}
},
"schema": {
"type": "object",
"properties": {
"reward": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/sku"
},
"name": {
"type": "string",
"example": "Super box",
"description": "Название товара."
},
"type": {
"type": "string",
"example": "bundle",
"description": "Тип товара."
},
"description": {
"type": "string",
"example": "Super box with items",
"description": "Описание товара."
},
"image_url": {
"$ref": "#/components/schemas/Common_admin-image_url"
},
"quantity": {
"type": "integer",
"example": 2,
"description": "Количество товаров."
},
"bundle_type": {
"type": "string",
"description": "Тип бандла. Возвращается, если тип предмета — бандл.",
"enum": [
"standard",
"virtual_currency_package"
]
}
}
}
}
}
}
}
}
},
"200-admin-get-list-reward-chains": {
"description": "Список цепочек наград был успешно получен.",
"content": {
"application/json": {
"examples": {
"response": {
"$ref": "#/components/examples/200-reward-chain-list"
}
},
"schema": {
"type": "object",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/admin-get-reward-chain-item-basic-model"
},
{
"$ref": "#/components/schemas/admin-get-reward-chain-item-clan-basic-model"
}
]
}
}
}
}
}
}
},
"201-admin-create-reward-chain": {
"description": "Цепочка наград была успешно создана.",
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"reward_chain_id": 10
}
}
},
"schema": {
"type": "object",
"properties": {
"reward_chain_id": {
"type": "integer",
"example": 10
}
}
}
}
}
},
"200-admin-get-reward-chain": {
"description": "Указанная цепочка наград была успешно получена.",
"content": {
"application/json": {
"examples": {
"common": {
"$ref": "#/components/examples/200-reward-chain"
},
"clan": {
"$ref": "#/components/examples/200-clan-reward-chain"
}
},
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/admin-get-reward-chain-item-full-model"
},
{
"$ref": "#/components/schemas/admin-get-reward-chain-item-clan-full-model"
}
]
}
}
}
},
"404-admin-reward-chain-not-found": {
"description": "Цепочка наград не найдена.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Reward chain not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 9901,
"errorMessage": "[0401-4001]: Reward chain not found"
}
}
}
}
}
},
"204-admin-update-reward-chain": {
"description": "Цепочка наград была успешно обновлена.",
"content": {}
},
"204-admin-delete-reward-chain": {
"description": "Цепочка наград была успешно удалена.",
"content": {}
},
"204-admin-toggle-reward-chain": {
"description": "Цепочка наград была отключена/включена.",
"content": {}
},
"204-admin-reset-reward-chain": {
"description": "Цепочка наград сброшена.",
"content": {}
},
"200-admin-get-list-daily-chains": {
"description": "Список ежедневных наград успешно получен.",
"content": {
"application/json": {
"examples": {
"response": {
"$ref": "#/components/examples/200-admin-daily-chain-list"
}
},
"schema": {
"type": "object",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"total_items_count": {
"type": "integer",
"example": 3,
"description": "Общее количество ежедневных наград."
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/admin-daily-chain-short-model"
}
}
}
}
}
}
},
"201-admin-create-daily-chain": {
"description": "Ежедневная награда была успешно создана.",
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"daily_chain_id": 10
}
}
},
"schema": {
"type": "object",
"properties": {
"daily_chain_id": {
"type": "integer",
"example": 10
}
}
}
}
}
},
"422-admin-create-error-list": {
"description": "Ошибки в настройках ежедневных наград.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/daily-chain-error-model"
},
"examples": {
"too-many-steps-error": {
"$ref": "#/components/examples/422-admin-daily-chain-error-too-many-steps"
},
"incorrect-steps-order-error": {
"$ref": "#/components/examples/422-admin-daily-chain-error-incorrect-steps-order"
},
"item-limit-exceeded": {
"$ref": "#/components/examples/422-admin-daily-chain-error-item-limit-exceeded"
},
"incorrect-items": {
"$ref": "#/components/examples/422-admin-daily-chain-error-incorrect-items"
},
"invalid-dates": {
"$ref": "#/components/examples/422-admin-daily-chain-error-invalid-dates"
},
"incorrect-period": {
"$ref": "#/components/examples/422-admin-daily-chain-error-incorrect-period"
}
}
}
}
},
"200-admin-get-daily-chain": {
"description": "Данные о ежедневной награде успешно получены.",
"content": {
"application/json": {
"examples": {
"response": {
"$ref": "#/components/examples/200-admin-daily-chain"
}
},
"schema": {
"$ref": "#/components/schemas/admin-daily-chain-long-model"
}
}
}
},
"404-daily-chain-not-found": {
"description": "Ежедневная награда не найдена.",
"content": {
"application/json": {
"examples": {
"not-found": {
"$ref": "#/components/examples/404-daily-chain-not-found"
}
},
"schema": {
"$ref": "#/components/schemas/daily-chain-error-model"
}
}
}
},
"422-admin-update-error-list": {
"description": "Ошибки в настройках ежедневных наград.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/daily-chain-error-model"
},
"examples": {
"too-many-steps-error": {
"$ref": "#/components/examples/422-admin-daily-chain-error-too-many-steps"
},
"incorrect-steps-order-error": {
"$ref": "#/components/examples/422-admin-daily-chain-error-incorrect-steps-order"
},
"item-limit-exceeded": {
"$ref": "#/components/examples/422-admin-daily-chain-error-item-limit-exceeded"
},
"incorrect-items": {
"$ref": "#/components/examples/422-admin-daily-chain-error-incorrect-items"
},
"invalid-dates": {
"$ref": "#/components/examples/422-admin-daily-chain-error-invalid-dates"
},
"incorrect-period": {
"$ref": "#/components/examples/422-admin-daily-chain-error-incorrect-period"
},
"invalid-chain-step-ids": {
"$ref": "#/components/examples/422-admin-daily-chain-error-invalid-chain-step-ids"
},
"chain-id-mismatch": {
"$ref": "#/components/examples/422-admin-daily-chain-error-chain-id-mismatch"
},
"chain-step-ids-duplication": {
"$ref": "#/components/examples/422-admin-daily-chain-error-duplicate-step-ids"
},
"active-daily-chain": {
"$ref": "#/components/examples/422-admin-daily-chain-error-activated"
}
}
}
}
},
"200-client-get-daily-chains-list": {
"description": "Ежедневные награды пользователя были успешно получены.",
"content": {
"application/json": {
"examples": {
"response": {
"$ref": "#/components/examples/200-client-daily-chain-list"
}
},
"schema": {
"type": "object",
"properties": {
"has_more": {
"type": "boolean",
"example": true,
"description": "Используется как индикатор того, что остались еще страницы."
},
"total_items_count": {
"type": "integer",
"example": 3,
"description": "Общее количество ежедневных наград."
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/client-daily-chain-model"
}
}
}
}
}
}
},
"401-client-auth-error": {
"description": "Данные для аутентификации не переданы или ошибочны.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1501
},
"errorMessage": {
"type": "string",
"example": "[0401-1501]: Authorization failed: Provide authorization"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1501,
"errorMessage": "[0401-1501]: Authorization failed: Provide authorization"
}
}
}
}
}
},
"404-daily-chain-step-not-found": {
"description": "Ежедневная награда или уровень ежедневной награды не найдены.",
"content": {
"application/json": {
"examples": {
"not-found": {
"$ref": "#/components/examples/404-daily-chain-step-not-found"
}
},
"schema": {
"$ref": "#/components/schemas/daily-chain-error-model"
}
}
}
},
"200-client-get-offer-chains-list": {
"description": "Цепочки предложений пользователя успешно получены.",
"content": {
"application/json": {
"examples": {
"response": {
"$ref": "#/components/examples/200-client-offer-chain-list"
}
},
"schema": {
"type": "object",
"properties": {
"has_more": {
"type": "boolean",
"example": true,
"description": "Показывает, доступны ли другие страницы."
},
"total_items_count": {
"type": "integer",
"example": 10,
"description": "Общее количество доступных цепочек предложений."
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/client-offer-chain-model"
}
}
}
}
}
}
},
"404-offer-chain-not-found": {
"description": "Цепочка предложений не найдена.",
"content": {
"application/json": {
"examples": {
"not-found": {
"$ref": "#/components/examples/404-offer-chain-not-found"
}
},
"schema": {
"$ref": "#/components/schemas/offer-chain-error-model"
}
}
}
},
"404-offer-chain-step-not-found": {
"description": "Цепочка предложений или уровень не найдены.",
"content": {
"application/json": {
"examples": {
"not-found": {
"$ref": "#/components/examples/404-offer-chain-step-not-found"
}
},
"schema": {
"$ref": "#/components/schemas/offer-chain-error-model"
}
}
}
},
"Cart-Payment_200-order-created": {
"description": "Заказ успешно создан.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"description": "ID заказа."
},
"token": {
"type": "string",
"description": "Платежный токен."
}
}
},
"examples": {
"response": {
"value": {
"order_id": 641,
"token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo"
}
}
}
}
}
},
"200-admin-get-list-offer-chains": {
"description": "Список цепочек предложений успешно получен.",
"content": {
"application/json": {
"examples": {
"response": {
"$ref": "#/components/examples/200-admin-offer-chain-list"
}
},
"schema": {
"type": "object",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/admin-offer-chain-short-model"
}
}
}
}
}
}
},
"201-admin-create-offer-chain": {
"description": "Цепочка предложений успешно создана.",
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"offer_chain_id": 10
}
}
},
"schema": {
"type": "object",
"properties": {
"offer_chain_id": {
"type": "integer",
"example": 10
}
}
}
}
}
},
"422-create-error-list": {
"description": "Некорректная конфигурация цепочки предложений.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/offer-chain-error-model"
},
"examples": {
"too-many-steps-error": {
"$ref": "#/components/examples/422-admin-offer-chain-error-too-many-steps"
},
"incorrect-steps-order-error": {
"$ref": "#/components/examples/422-admin-offer-chain-error-incorrect-steps-order"
},
"item-limit-exceeded": {
"$ref": "#/components/examples/422-admin-offer-chain-error-item-limit-exceeded"
},
"incorrect-items": {
"$ref": "#/components/examples/422-admin-offer-chain-error-incorrect-items"
},
"invalid-dates": {
"$ref": "#/components/examples/422-admin-offer-chain-error-invalid-dates"
},
"incorrect-period": {
"$ref": "#/components/examples/422-admin-offer-chain-error-incorrect-period"
}
}
}
}
},
"200-admin-get-offer-chain": {
"description": "Данные цепочки предложений успешно получены.",
"content": {
"application/json": {
"examples": {
"response": {
"$ref": "#/components/examples/200-admin-offer-chain"
}
},
"schema": {
"$ref": "#/components/schemas/admin-offer-chain-long-model"
}
}
}
},
"422-update-error-list": {
"description": "Некорректная конфигурация цепочки предложений.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/offer-chain-error-model"
},
"examples": {
"too-many-steps-error": {
"$ref": "#/components/examples/422-admin-offer-chain-error-too-many-steps"
},
"incorrect-steps-order-error": {
"$ref": "#/components/examples/422-admin-offer-chain-error-incorrect-steps-order"
},
"item-limit-exceeded": {
"$ref": "#/components/examples/422-admin-offer-chain-error-item-limit-exceeded"
},
"incorrect-items": {
"$ref": "#/components/examples/422-admin-offer-chain-error-incorrect-items"
},
"invalid-dates": {
"$ref": "#/components/examples/422-admin-offer-chain-error-invalid-dates"
},
"incorrect-period": {
"$ref": "#/components/examples/422-admin-offer-chain-error-incorrect-period"
},
"invalid-chain-step-ids": {
"$ref": "#/components/examples/422-admin-offer-chain-error-invalid-chain-step-ids"
},
"chain-id-mismatch": {
"$ref": "#/components/examples/422-admin-offer-chain-error-chain-id-mismatch"
},
"chain-step-ids-duplication": {
"$ref": "#/components/examples/422-admin-offer-chain-error-duplicate-step-ids"
},
"active-offer-chain": {
"$ref": "#/components/examples/422-admin-offer-chain-error-activated"
}
}
}
}
},
"Upsell-404-item-not-found": {
"description": "Товар не найден.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Items weren't found: sku1, sku2"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 9901,
"errorMessage": "[0401-4001]: Items weren't found: sku1, sku2"
}
}
}
}
}
},
"Upsell-422-invalid-request": {
"description": "Неверный запрос.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Upsell-422-invalid-request"
}
}
}
},
"Upsell-200-get-client-list": {
"description": "Список товаров для апселла успешно получен.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Upsell_item-list"
},
"examples": {
"response": {
"value": {
"has_more": true,
"items": [
{
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"groups": [
{
"external_id": "accessory",
"name": {
"en": "accessory"
}
}
],
"attributes": [
{
"external_id": "stack_size",
"name": {
"en": "Quantity of items in the upsell set"
},
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
}
],
"type": "virtual_good",
"description": "Big Rocket - description",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"is_free": false,
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": null,
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
},
{
"quantity": 1,
"sku": "com.xsolla.phys_good_1",
"type": "physical_good"
},
{
"quantity": 1,
"name": "Super Lootbox with items",
"image_url": "https://cdn.xsolla.net/img/misc/images/9676f06265375087e607cb79c5283688.png",
"sku": "com.xsolla.SuperLootboxBundle_1",
"type": "bundle",
"bundle_type": "standard"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"vp_rewards": []
},
{
"sku": "com.xsolla.shotgun_raider_1",
"name": "SHOTGUN FOR TRUE RAIDERS",
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
}
],
"attributes": [
{
"external_id": "stack_size",
"name": {
"en": "Quantity of items in the upsell set"
},
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
},
{
"external_id": "rating",
"name": {
"en": "Items rating"
},
"values": [
{
"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"type": "virtual_good",
"description": "description",
"image_url": "http://image.png",
"is_free": false,
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_2",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
},
{
"amount": 200,
"sku": "com.xsolla.vc_3",
"is_default": false,
"amount_without_discount": 200,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [],
"limits": null,
"periods": [
{
"date_from": "2020-08-11T20:00:00+03:00",
"date_until": null
}
],
"vp_rewards": []
},
{
"sku": "com.xsolla.shotgun_raider_2",
"name": "SHOTGUN FOR TRUE RAIDERS",
"groups": [],
"attributes": [],
"type": "virtual_good",
"description": "description",
"image_url": "http://image.png",
"is_free": true,
"price": null,
"virtual_prices": [],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [],
"limits": null,
"periods": [],
"vp_rewards": []
}
]
}
}
}
}
}
},
"200-get-loyalty-program": {
"description": "Информация о программе лояльности успешно получена.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID программы лояльности. "
},
"project_id": {
"type": "integer",
"format": "uint32",
"description": "ID проекта, которому принадлежит программа."
},
"name": {
"$ref": "#/components/schemas/two-letter-locale",
"description": "Объект с локализациями названия программы лояльности. Ключи — двухбуквенные коды языков в нижнем регистре (например, en). Полный список поддерживаемых языков приведен в документации."
},
"description": {
"$ref": "#/components/schemas/two-letter-locale",
"description": "Объект с локализациями описания программы лояльности. Ключи — двухбуквенные коды языков в нижнем регистре (например, en). Полный список поддерживаемых языков приведен в документации."
},
"external_id": {
"type": "string",
"description": "ID программы лояльности в вашей системе."
},
"is_active": {
"type": "boolean",
"description": "Активна ли программа лояльности."
},
"spend_max_threshold": {
"type": "number",
"format": "double",
"description": "Максимальная доля стоимости заказа в процентах, которую пользователь может оплатить баллами лояльности."
},
"cashback_policy": {
"type": "object",
"description": "Правила начисления пользователю баллов лояльности в виде кешбэка за покупки.",
"properties": {
"type": {
"type": "string",
"description": "Тип расчета кешбэка: `static` — ко всем заказам применяется фиксированный процент; `dynamic` — процент зависит от диапазона суммы заказа.",
"enum": [
"static",
"dynamic"
]
},
"ranges": {
"type": "array",
"description": "Диапазоны сумм заказа с процентом кешбэка для каждого диапазона.",
"items": {
"type": "object",
"properties": {
"min": {
"type": "string",
"description": "Минимальная сумма заказа для диапазона (включительно)."
},
"max": {
"type": "string",
"description": "Максимальная сумма заказа для диапазона (включительно). Для диапазона без верхней границы укажите `inf`."
},
"currency_code": {
"type": "string",
"description": "Валюта диапазона в формате ISO 4217."
},
"percentage": {
"type": "string",
"description": "Процент кешбэка для заказов в пределах диапазона."
}
}
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"id": "c0de0000-0000-0000-0000-000000000001",
"project_id": 89203,
"name": {
"en": "Program name"
},
"description": {
"en": "Program description"
},
"external_id": "external-id-89203",
"is_active": true,
"spend_max_threshold": 45,
"cashback_policy": {
"type": "dynamic",
"ranges": [
{
"currency_code": "USD",
"min": "0",
"max": "100",
"percentage": "5"
}
]
}
}
}
}
}
}
},
"401-invalid-auth": {
"description": "Неверная авторизация."
},
"404-program-not-found": {
"description": "Программа лояльности не найдена.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Краткое описание ошибки.",
"example": "loyalty program not found."
}
}
},
"examples": {
"response": {
"value": {
"message": "loyalty program not found."
}
}
}
}
}
},
"200-get-program-loyalty-points": {
"description": "Список баллов лояльности успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID балла лояльности."
},
"program_id": {
"type": "string",
"description": "ID программы лояльности, которой принадлежит балл."
},
"name": {
"$ref": "#/components/schemas/two-letter-locale",
"description": "Объект с локализациями названия балла лояльности. Ключи — двухбуквенные коды языков в нижнем регистре (например, en). Полный список поддерживаемых языков приведен в документации."
},
"description": {
"$ref": "#/components/schemas/two-letter-locale",
"description": "Объект с локализациями описания балла лояльности. Ключи — двухбуквенные коды языков в нижнем регистре (например, en). Полный список поддерживаемых языков приведен в документации."
},
"icon_url": {
"type": "string",
"format": "uri",
"description": "URL-адрес изображения."
},
"exchange_rate": {
"type": "object",
"description": "Денежная стоимость балла лояльности в разных валютах.",
"properties": {
"rates": {
"type": "array",
"description": "Список курсов обмена для каждой валюты.",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Код валюты в формате ISO 4217."
},
"rate": {
"type": "number",
"format": "double",
"description": "Денежная стоимость одного балла лояльности в указанной валюте."
}
}
}
}
}
},
"linked_sku": {
"type": "object",
"description": "Артикулы товаров, за покупку которых начисляются баллы лояльности. Содержит массив с артикулами товаров. По умолчанию значение `\"*\"` – баллы начисляются за все товары."
},
"amount_of_points_per_dollar": {
"type": "integer",
"description": "Количество баллов лояльности, которое пользователь получает за каждую потраченную единицу валюты."
}
}
}
},
"examples": {
"response": {
"value": [
{
"id": "d0750000-0000-0000-0000-000000000001",
"program_id": "c0de0000-0000-0000-0000-000000000001",
"name": {
"en": "point-en"
},
"description": {
"en": "point-desc"
},
"icon_url": "https://example.com/icon.png",
"exchange_rate": {
"rates": [
{
"code": "USD",
"rate": 0.25
}
]
},
"linked_sku": {
"sku": [
"*"
]
},
"amount_of_points_per_dollar": 4
}
]
}
}
}
}
},
"200-get-point-balance": {
"description": "Баланс баллов лояльности успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"balance"
],
"properties": {
"balance": {
"type": "number",
"format": "double",
"description": "Текущий баланс указанных баллов лояльности.",
"example": 150.5
}
}
},
"examples": {
"response": {
"value": {
"balance": 150.5
}
}
}
}
}
},
"ItemGroup_401-invalid-basic-auth": {
"description": "Базовая аутентификация не пройдена или указаны неверные данные. Убедитесь, что вы используете базовую аутентификацию и правильные учетные данные.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error-response-base"
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"404-user-or-point-not-found": {
"description": "Аккаунт пользователя или баллы лояльности не найдены.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"message_id",
"message"
],
"properties": {
"message_id": {
"type": "string",
"description": "Код ошибки.",
"example": "error_not_found"
},
"message": {
"type": "string",
"description": "Краткое описание ошибки.",
"example": "User account or loyalty points not found."
}
}
},
"examples": {
"response": {
"value": {
"message_id": "error_not_found",
"message": "User account or loyalty points not found."
}
}
}
}
}
},
"200-debit-point-balance": {
"description": "Баллы лояльности успешно списаны с баланса пользователя.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"transaction_id",
"previous_balance",
"new_balance",
"amount"
],
"properties": {
"transaction_id": {
"type": "string",
"format": "uuid",
"description": "ID транзакции списания, созданной в результате запроса.",
"example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"previous_balance": {
"type": "number",
"format": "double",
"description": "Баланс баллов лояльности до списания.",
"example": 150.5
},
"new_balance": {
"type": "number",
"format": "double",
"description": "Баланс баллов лояльности после списания.",
"example": 100.5
},
"amount": {
"type": "number",
"format": "double",
"description": "Количество списанных баллов лояльности.",
"example": 50
}
}
},
"examples": {
"response": {
"value": {
"transaction_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"previous_balance": 150.5,
"new_balance": 100.5,
"amount": 50
}
}
}
}
}
},
"400-bad-request": {
"description": "Некорректный запрос. Запрос содержит недопустимые параметры.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"message_id",
"message"
],
"properties": {
"message_id": {
"type": "string",
"description": "Код ошибки.",
"example": "error_bad_request"
},
"message": {
"type": "string",
"description": "Краткое описание ошибки.",
"example": "Invalid request body."
}
}
},
"examples": {
"response": {
"value": {
"message_id": "error_bad_request",
"message": "Invalid request body."
}
}
}
}
}
},
"422-insufficient-balance": {
"description": "На балансе пользователя недостаточно баллов для списания.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"message_id",
"message"
],
"properties": {
"message_id": {
"type": "string",
"description": "Код ошибки.",
"example": "error_bad_request"
},
"message": {
"type": "string",
"description": "Краткое описание ошибки.",
"example": "Insufficient loyalty point balance."
}
}
},
"examples": {
"response": {
"value": {
"message_id": "error_bad_request",
"message": "Insufficient loyalty point balance."
}
}
}
}
}
},
"200-credit-point-balance": {
"description": "Баллы лояльности успешно начислены на баланс пользователя.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"transaction_id",
"previous_balance",
"new_balance",
"amount"
],
"properties": {
"transaction_id": {
"type": "string",
"format": "uuid",
"description": "ID транзакции начисления, созданной в результате запроса.",
"example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"previous_balance": {
"type": "number",
"format": "double",
"description": "Баланс баллов лояльности до начисления.",
"example": 100.5
},
"new_balance": {
"type": "number",
"format": "double",
"description": "Баланс баллов лояльности после начисления.",
"example": 150.5
},
"amount": {
"type": "number",
"format": "double",
"description": "Количество начисленных баллов лояльности.",
"example": 50
}
}
},
"examples": {
"response": {
"value": {
"transaction_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"previous_balance": 100.5,
"new_balance": 150.5,
"amount": 50
}
}
}
}
}
},
"200-get-client-point-balance": {
"description": "Баланс баллов лояльности успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "Список баллов лояльности пользователя с их текущими балансами.",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "Артикул балла лояльности. Используйте это значение в параметре `loyalty_point_sku` в других запросах API, например при создании заказа, оплачиваемого баллами лояльности."
},
"name": {
"type": "string",
"description": "Название баллов лояльности."
},
"description": {
"type": "string",
"description": "Описание баллов лояльности."
},
"image_url": {
"type": "string",
"description": "URL-адрес изображения."
},
"amount": {
"type": "number",
"description": "Текущий баланс указанного балла лояльности."
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"items": [
{
"sku": "d0750000-0000-0000-0000-000000000001",
"name": "Point name",
"description": "Point description",
"image_url": "https://example.com/icon.png",
"amount": 100
}
]
}
}
}
}
}
},
"200-purchase-by-loyalty-points": {
"description": "Покупка за баллы лояльности успешно совершена.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"description": "ID заказа."
}
}
},
"examples": {
"response": {
"value": {
"order_id": 641
}
}
}
}
}
},
"422-purchase-by-loyalty-points": {
"description": "На балансе пользователя недостаточно баллов лояльности, или товар не может быть куплен за баллы лояльности.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"example": 9971
},
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"description": "Сообщение об ошибке.",
"example": "[0401-9971]: Not enough loyalty points"
}
}
},
"examples": {
"Not enough loyalty points": {
"value": {
"errorCode": 9971,
"statusCode": 422,
"errorMessage": "[0401-9971]: Not enough loyalty points"
}
},
"Not eligible item": {
"value": {
"errorCode": 9970,
"statusCode": 422,
"errorMessage": "[0401-9970]: Item cannot be purchased using loyalty points"
}
}
}
}
}
}
},
"requestBodies": {
"Promotions_redeem-coupon-model": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"coupon_code": {
"type": "string",
"description": "Уникальный код купона. Содержит буквы и цифры.",
"minLength": 1,
"maxLength": 128,
"example": "WINTER2021",
"default": "WINTER2021"
},
"selected_unit_items": {
"$ref": "#/components/schemas/Promotions_selected_unit_items"
}
}
}
}
}
},
"Promotions_coupon-create": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"external_id",
"name"
],
"properties": {
"external_id": {
"$ref": "#/components/schemas/Promotions_coupon-external_id"
},
"promotion_periods": {
"$ref": "#/components/schemas/promotion_periods"
},
"name": {
"$ref": "#/components/schemas/Promotions_coupon_name"
},
"bonus": {
"$ref": "#/components/schemas/Promotions_coupon_bonus"
},
"redeem_total_limit": {
"$ref": "#/components/schemas/Promotions_coupon-redeem_total_limit"
},
"redeem_user_limit": {
"$ref": "#/components/schemas/Promotions_coupon-redeem_user_limit"
},
"redeem_code_limit": {
"$ref": "#/components/schemas/Promotions_redeem_code_limit"
},
"attribute_conditions": {
"$ref": "#/components/schemas/promotion_user-attribute_conditions_model-post"
}
}
},
"examples": {
"simple": {
"value": {
"external_id": "coupon_external_id",
"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 Bonus",
"de-DE": "Neujahrsbonus"
},
"redeem_total_limit": 100,
"redeem_user_limit": 1,
"redeem_code_limit": 1,
"bonus": [
{
"sku": "com.xsolla.elven_sword_1",
"quantity": 1
}
]
}
},
"personalized": {
"value": {
"external_id": "coupon_external_id",
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"name": {
"en-US": "New Year Bonus",
"de-DE": "Neujahrsbonus"
},
"redeem_total_limit": 100,
"redeem_user_limit": 1,
"redeem_code_limit": 1,
"bonus": [
{
"sku": "com.xsolla.elven_sword_2",
"quantity": 1
}
],
"attribute_conditions": [
{
"attribute": "account_status",
"type": "string",
"operator": "eq",
"value": "golden",
"can_be_missing": false
}
]
}
}
}
}
}
},
"Promotions_coupon-update": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name"
],
"properties": {
"promotion_periods": {
"$ref": "#/components/schemas/promotion_periods"
},
"name": {
"$ref": "#/components/schemas/Promotions_coupon_name"
},
"bonus": {
"$ref": "#/components/schemas/Promotions_coupon_bonus"
},
"redeem_total_limit": {
"$ref": "#/components/schemas/Promotions_coupon-redeem_total_limit"
},
"redeem_user_limit": {
"$ref": "#/components/schemas/Promotions_coupon-redeem_user_limit"
},
"redeem_code_limit": {
"$ref": "#/components/schemas/Promotions_redeem_code_limit"
},
"attribute_conditions": {
"$ref": "#/components/schemas/promotion_user-attribute_conditions_model-post"
}
}
},
"examples": {
"simple": {
"value": {
"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 Bonus",
"de-DE": "Neujahrsbonus"
},
"redeem_total_limit": 100,
"redeem_user_limit": 1,
"redeem_code_limit": 1,
"bonus": [
{
"sku": "com.xsolla.elven_sword_1",
"quantity": 1
}
]
}
},
"personalized": {
"value": {
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"name": {
"en-US": "New Year Bonus",
"de-DE": "Neujahrsbonus"
},
"redeem_total_limit": 100,
"redeem_user_limit": 1,
"redeem_code_limit": 1,
"bonus": [
{
"sku": "com.xsolla.elven_sword_2",
"quantity": 1
}
],
"attribute_conditions": [
{
"attribute": "account_status",
"type": "string",
"operator": "eq",
"value": "golden",
"can_be_missing": false
}
]
}
}
}
}
}
},
"Promotions_create-coupon-promocode-code": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"coupon_code": {
"$ref": "#/components/schemas/Promotions_coupon_code"
}
}
}
}
}
},
"Promotions_redeem-promo-code-model": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"coupon_code": {
"type": "string",
"description": "Уникальный код промокода. Содержит буквы и цифры.",
"minLength": 1,
"maxLength": 128,
"example": "SUMMER2021",
"default": "SUMMER2021"
},
"cart": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string",
"description": "ID корзины.",
"default": "current"
}
},
"required": [
"id"
]
},
"selected_unit_items": {
"$ref": "#/components/schemas/Promotions_selected_unit_items"
}
}
}
}
}
},
"Promotions_cancel-promo-code-model": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cart": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string",
"description": "ID корзины.",
"default": "current"
}
},
"required": [
"id"
]
}
}
}
}
}
},
"Promotions_promocode-create": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"external_id",
"name"
],
"properties": {
"external_id": {
"$ref": "#/components/schemas/Promotions_coupon-external_id"
},
"promotion_periods": {
"$ref": "#/components/schemas/promotion_periods"
},
"name": {
"$ref": "#/components/schemas/Promotions_coupon_name"
},
"bonus": {
"$ref": "#/components/schemas/Promotions_coupon_bonus"
},
"redeem_total_limit": {
"$ref": "#/components/schemas/Promotions_coupon-redeem_total_limit"
},
"redeem_user_limit": {
"$ref": "#/components/schemas/Promotions_coupon-redeem_user_limit"
},
"redeem_code_limit": {
"$ref": "#/components/schemas/Promotions_redeem_code_limit"
},
"discount": {
"type": [
"object",
"null"
],
"properties": {
"percent": {
"$ref": "#/components/schemas/Promotions_promotion_discount_percent"
}
},
"example": {
"percent": "10.10"
}
},
"discounted_items": {
"$ref": "#/components/schemas/Promotions_discounted_items"
},
"attribute_conditions": {
"$ref": "#/components/schemas/promotion_user-attribute_conditions_model-post"
},
"price_conditions": {
"$ref": "#/components/schemas/price_conditions_promocode"
},
"item_price_conditions": {
"$ref": "#/components/schemas/item_price_conditions_promocode"
},
"excluded_promotions": {
"$ref": "#/components/schemas/excluded_promotions"
}
}
},
"examples": {
"simple bonus": {
"value": {
"external_id": "promo_code_external_id",
"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 Bonus",
"de-DE": "Neujahrsbonus"
},
"redeem_total_limit": 100,
"redeem_user_limit": 1,
"redeem_code_limit": 1,
"bonus": [
{
"sku": "com.xsolla.elven_sword_1",
"quantity": 1
},
{
"sku": "com.xsolla.elven_shield_1",
"quantity": 2
},
{
"sku": "com.xsolla.elven_gloves_1",
"quantity": 2
}
]
}
},
"simple discount": {
"value": {
"external_id": "promo_code_external_id",
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"name": {
"en-US": "New Year Discount",
"de-DE": "Neujahrsrabatt"
},
"redeem_total_limit": 100,
"redeem_user_limit": 1,
"redeem_code_limit": 1,
"discount": {
"percent": "10.10"
}
}
},
"personalized": {
"value": {
"external_id": "coupon_external_id",
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"name": {
"en-US": "New Year Discount",
"de-DE": "Neujahrsrabatt"
},
"redeem_total_limit": 100,
"redeem_user_limit": 1,
"redeem_code_limit": 1,
"discount": {
"percent": "10.10"
},
"attribute_conditions": [
{
"attribute": "account_status",
"type": "string",
"operator": "eq",
"value": "golden",
"can_be_missing": false
}
]
}
},
"with price conditions": {
"value": {
"external_id": "promo_code_external_id",
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"name": {
"en-US": "New Year Bonus",
"de-DE": "Neujahrsbonus"
},
"redeem_total_limit": 100,
"redeem_user_limit": 1,
"redeem_code_limit": 1,
"bonus": [
{
"sku": "com.xsolla.elven_sword_2",
"quantity": 1
},
{
"sku": "com.xsolla.elven_shield_2",
"quantity": 2
},
{
"sku": "com.xsolla.elven_gloves_2",
"quantity": 2
}
],
"price_conditions": [
{
"operator": "ge",
"value": "10.5000"
},
{
"operator": "lt",
"value": "50.0000"
}
]
}
},
"with item price conditions": {
"value": {
"external_id": "promo_code_external_id",
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"name": {
"en-US": "New Year Bonus",
"de-DE": "Neujahrsbonus"
},
"redeem_total_limit": 100,
"redeem_user_limit": 1,
"redeem_code_limit": 1,
"discount": {
"percent": "10.10"
},
"bonus": [
{
"sku": "com.xsolla.elven_sword_3",
"quantity": 1
},
{
"sku": "com.xsolla.elven_shield_3",
"quantity": 2
},
{
"sku": "com.xsolla.elven_gloves_3",
"quantity": 2
}
],
"item_price_conditions": [
{
"operator": "ge",
"value": "10.5000"
},
{
"operator": "lt",
"value": "50.0000"
}
]
}
},
"with excluded promotions": {
"value": {
"external_id": "coupon_external_id",
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"name": {
"en-US": "New Year Discount",
"de-DE": "Neujahrsrabatt"
},
"redeem_total_limit": 100,
"redeem_user_limit": 1,
"redeem_code_limit": 1,
"discount": {
"percent": "10.10"
},
"excluded_promotions": [
12,
789
]
}
}
}
}
}
},
"Promotions_promocode-update": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name"
],
"properties": {
"promotion_periods": {
"$ref": "#/components/schemas/promotion_periods"
},
"name": {
"$ref": "#/components/schemas/Promotions_coupon_name"
},
"bonus": {
"$ref": "#/components/schemas/Promotions_coupon_bonus"
},
"redeem_total_limit": {
"$ref": "#/components/schemas/Promotions_coupon-redeem_total_limit"
},
"redeem_user_limit": {
"$ref": "#/components/schemas/Promotions_coupon-redeem_user_limit"
},
"redeem_code_limit": {
"$ref": "#/components/schemas/Promotions_redeem_code_limit"
},
"discount": {
"type": [
"object",
"null"
],
"properties": {
"percent": {
"$ref": "#/components/schemas/Promotions_promotion_discount_percent"
}
},
"example": {
"percent": "10.10"
}
},
"discounted_items": {
"$ref": "#/components/schemas/Promotions_discounted_items"
},
"attribute_conditions": {
"$ref": "#/components/schemas/promotion_user-attribute_conditions_model-post"
},
"price_conditions": {
"$ref": "#/components/schemas/price_conditions_promocode"
},
"item_price_conditions": {
"$ref": "#/components/schemas/item_price_conditions_promocode"
},
"excluded_promotions": {
"$ref": "#/components/schemas/excluded_promotions"
}
}
},
"examples": {
"simple bonus": {
"value": {
"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 Bonus",
"de-DE": "Neujahrsbonus"
},
"redeem_total_limit": 100,
"redeem_user_limit": 1,
"redeem_code_limit": 1,
"bonus": [
{
"sku": "com.xsolla.elven_sword_1",
"quantity": 1
},
{
"sku": "com.xsolla.elven_shield_1",
"quantity": 2
},
{
"sku": "com.xsolla.elven_gloves_1",
"quantity": 2
}
]
}
},
"simple discount": {
"value": {
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"name": {
"en-US": "New Year Discount",
"de-DE": "Neujahrsrabatt"
},
"redeem_total_limit": 100,
"redeem_user_limit": 1,
"redeem_code_limit": 1,
"discount": {
"percent": "10.10"
}
}
},
"personalized": {
"value": {
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"name": {
"en-US": "New Year Discount",
"de-DE": "Neujahrsrabatt"
},
"redeem_total_limit": 100,
"redeem_user_limit": 1,
"redeem_code_limit": 1,
"discount": {
"percent": "10.10"
},
"attribute_conditions": [
{
"attribute": "account_status",
"type": "string",
"operator": "eq",
"value": "golden",
"can_be_missing": false
}
]
}
},
"with price conditions": {
"value": {
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"name": {
"en-US": "New Year Bonus",
"de-DE": "Neujahrsbonus"
},
"redeem_total_limit": 100,
"redeem_user_limit": 1,
"redeem_code_limit": 1,
"bonus": [
{
"sku": "com.xsolla.elven_sword_2",
"quantity": 1
},
{
"sku": "com.xsolla.elven_shield_2",
"quantity": 2
},
{
"sku": "com.xsolla.elven_gloves_2",
"quantity": 2
}
],
"price_conditions": [
{
"operator": "gt",
"value": "10.5000"
},
{
"operator": "lt",
"value": "50.0000"
}
]
}
},
"with item price conditions": {
"value": {
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"name": {
"en-US": "New Year Bonus",
"de-DE": "Neujahrsbonus"
},
"redeem_total_limit": 100,
"redeem_user_limit": 1,
"redeem_code_limit": 1,
"discount": {
"percent": "10.10"
},
"bonus": [
{
"sku": "com.xsolla.elven_sword_3",
"quantity": 1
},
{
"sku": "com.xsolla.elven_shield_3",
"quantity": 2
},
{
"sku": "com.xsolla.elven_gloves_3",
"quantity": 2
}
],
"item_price_conditions": [
{
"operator": "gt",
"value": "10.5000"
},
{
"operator": "lt",
"value": "50.0000"
}
]
}
},
"with excluded promotions": {
"value": {
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"name": {
"en-US": "New Year Discount",
"de-DE": "Neujahrsrabatt"
},
"redeem_total_limit": 100,
"redeem_user_limit": 1,
"redeem_code_limit": 1,
"discount": {
"percent": "10.10"
},
"excluded_promotions": [
12,
789
]
}
}
}
}
}
},
"Promotions_create-update-item-promotion": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "object",
"description": "Название акции. Данный параметр должен содержать пары ключ/значение,\n где ключ — это локаль в формате \"^[a-z]{2}-[A-Z]{2}$\", значение — строка.",
"additionalProperties": {
"type": "string"
},
"example": {
"en-US": "Promotion",
"ru-RU": "Акция"
}
},
"promotion_periods": {
"$ref": "#/components/schemas/promotion_periods"
},
"discount": {
"type": "object",
"properties": {
"percent": {
"type": "string",
"description": "Процент скидки.\nЦена товара будет уменьшена с использованием значения, рассчитанного с использованием этого процента, а затем округлена до 2 знаков после запятой.",
"example": 10
}
},
"required": [
"percent"
]
},
"items": {
"type": "array",
"items": {
"description": "Список товаров, на которые будет распространяться скидка.",
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "Артикул товара.",
"default": "elven_sword"
}
},
"required": [
"sku"
]
}
},
"attribute_conditions": {
"$ref": "#/components/schemas/promotion_user-attribute_conditions_model-post"
},
"price_conditions": {
"$ref": "#/components/schemas/price_conditions_discount"
},
"limits": {
"$ref": "#/components/schemas/Promotions_promotion_limits"
},
"excluded_promotions": {
"$ref": "#/components/schemas/excluded_promotions"
},
"is_enabled": {
"$ref": "#/components/schemas/Promotions_is_enabled"
}
},
"required": [
"items",
"discount",
"name"
]
},
"examples": {
"simple": {
"value": {
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
},
{
"date_from": "2020-05-16T18:16:00+05:00",
"date_until": "2020-05-25T18:16:00+05:00"
}
],
"discount": {
"percent": "10.00"
},
"items": [
{
"sku": "com.xsolla.elven_sword_1"
},
{
"sku": "com.xsolla.elven_helmet_1"
},
{
"sku": "com.xsolla.elven_armor_1"
}
],
"name": {
"en-US": "Promotion",
"ru-RU": "Акция"
},
"is_enabled": true
}
},
"personalized": {
"value": {
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"discount": {
"percent": "24.00"
},
"items": [],
"is_enabled": true,
"name": {
"en-US": "Ork set discount",
"ru-RU": "Скидка на набор для орка"
},
"attribute_conditions": [
{
"type": "string",
"attribute": "race",
"operator": "eq",
"value": "ork"
},
{
"type": "number",
"attribute": "level",
"operator": "eq",
"value": "10",
"can_be_missing": true
}
]
}
},
"with price condition": {
"value": {
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"discount": {
"percent": "24.00"
},
"items": [],
"name": {
"en-US": "Ork set discount",
"ru-RU": "Скидка на набор для орка"
},
"price_conditions": [
{
"operator": "ge",
"value": "10.5000"
},
{
"operator": "lt",
"value": "20.5000"
}
]
}
},
"with excluded promotions": {
"value": {
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"discount": {
"percent": "24.00"
},
"items": [],
"name": {
"en-US": "Ork set discount",
"ru-RU": "Скидка на набор для орка"
},
"excluded_promotions": [
12,
789
],
"is_enabled": true
}
}
}
}
},
"description": "Объект с данными акции.",
"required": true
},
"Promotions_create-update-bonus-promotion": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"condition",
"bonus",
"name"
],
"properties": {
"id": {
"type": "integer",
"description": "ID акции. Уникальный идентификатор акции в рамках проекта."
},
"promotion_periods": {
"$ref": "#/components/schemas/promotion_periods"
},
"name": {
"type": "object",
"description": "Название акции. Данный параметр должен содержать пары ключ/значение, где ключ — это локаль в формате \"^[a-z]{2}-[A-Z]{2}$\", значение — строка.",
"additionalProperties": {
"type": "string"
},
"example": {
"en-US": "Summer season bonus",
"de-DE": "Sommersaison Bonus"
}
},
"condition": {
"type": [
"array",
"null"
],
"description": "Набор товаров, которые необходимо включить в покупку для применения акции. Если этот параметр равен `null`, акция будет применена к любым покупкам в рамках проекта.",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "Артикул товара.",
"default": "elven_sword"
}
}
}
},
"attribute_conditions": {
"$ref": "#/components/schemas/promotion_user-attribute_conditions_model-post"
},
"bonus": {
"type": [
"array",
"null"
],
"items": {
"description": "Список товаров, которые будут добавлены в покупку пользователя в качестве бонуса.",
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "Артикул товара.",
"default": "elven_shield"
},
"quantity": {
"type": "number",
"description": "Количество товаров.",
"default": 1
}
}
}
},
"limits": {
"$ref": "#/components/schemas/Promotions_promotion_limits"
},
"price_conditions": {
"$ref": "#/components/schemas/price_conditions_bonus"
},
"excluded_promotions": {
"$ref": "#/components/schemas/excluded_promotions"
},
"is_enabled": {
"$ref": "#/components/schemas/Promotions_is_enabled"
}
}
},
"examples": {
"simple": {
"value": {
"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 Bonus",
"de-DE": "Neujahrsbonus"
},
"condition": [
{
"sku": "com.xsolla.elven_boots_1"
},
{
"sku": "com.xsolla.elven_knife_1"
}
],
"bonus": [
{
"sku": "com.xsolla.elven_sword_1",
"quantity": 1
},
{
"sku": "com.xsolla.elven_shield_1",
"quantity": 2
},
{
"sku": "com.xsolla.elven_gloves_1",
"quantity": 2
}
]
}
},
"personalized": {
"value": {
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"name": {
"en-US": "New Year Bonus",
"de-DE": "Neujahrsbonus"
},
"condition": [
{
"sku": "com.xsolla.year_1_season_pass"
}
],
"attribute_conditions": [
{
"attribute": "account_status",
"type": "string",
"operator": "eq",
"value": "golden",
"can_be_missing": false
}
],
"bonus": [
{
"sku": "com.xsolla.mp_credits",
"quantity": 50000
}
]
}
},
"with price conditions": {
"value": {
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"name": {
"en-US": "New Year Bonus",
"de-DE": "Neujahrsbonus"
},
"condition": [
{
"sku": "com.xsolla.elven_boots_2"
},
{
"sku": "com.xsolla.elven_knife_2"
}
],
"bonus": [
{
"sku": "com.xsolla.elven_sword_2",
"quantity": 1
},
{
"sku": "com.xsolla.elven_shield_2",
"quantity": 2
},
{
"sku": "com.xsolla.elven_gloves_2",
"quantity": 2
}
],
"price_conditions": [
{
"operator": "gt",
"value": "10.0000"
},
{
"operator": "lt",
"value": "20.0000"
}
]
}
},
"with excluded promotions": {
"value": {
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"name": {
"en-US": "New Year Bonus",
"de-DE": "Neujahrsbonus"
},
"condition": [
{
"sku": "com.xsolla.year_1_season_pass"
}
],
"bonus": [
{
"sku": "com.xsolla.mp_credits",
"quantity": 50000
}
],
"excluded_promotions": [
12,
789
]
}
}
}
}
}
},
"Promotions_unique_catalog_offer-create": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"external_id",
"name"
],
"properties": {
"external_id": {
"$ref": "#/components/schemas/Promotions_coupon-external_id"
},
"date_start": {
"$ref": "#/components/schemas/Promotions_coupon_date_start"
},
"date_end": {
"$ref": "#/components/schemas/Promotions_coupon_date_end"
},
"name": {
"$ref": "#/components/schemas/Promotions_coupon_name"
},
"items": {
"type": "array",
"$ref": "#/components/schemas/Promotions_unique_catalog_offer_items"
},
"redeem_user_limit": {
"$ref": "#/components/schemas/Promotions_coupon-redeem_user_limit"
},
"redeem_code_limit": {
"$ref": "#/components/schemas/Promotions_redeem_code_limit"
},
"redeem_total_limit": {
"$ref": "#/components/schemas/Promotions_coupon-redeem_total_limit"
}
}
},
"examples": {
"simple": {
"value": {
"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"
]
}
},
"limited": {
"value": {
"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"
],
"redeem_total_limit": 100,
"redeem_user_limit": 1,
"redeem_code_limit": 1
}
}
}
}
}
},
"Promotions_unique_catalog_offer-update": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name"
],
"properties": {
"promotion_periods": {
"$ref": "#/components/schemas/promotion_periods"
},
"name": {
"$ref": "#/components/schemas/Promotions_coupon_name"
},
"items": {
"$ref": "#/components/schemas/Promotions_unique_catalog_offer_items"
},
"redeem_total_limit": {
"$ref": "#/components/schemas/Promotions_coupon-redeem_total_limit"
},
"redeem_user_limit": {
"$ref": "#/components/schemas/Promotions_coupon-redeem_user_limit"
},
"redeem_code_limit": {
"$ref": "#/components/schemas/Promotions_redeem_code_limit"
}
}
},
"examples": {
"simple": {
"value": {
"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"
]
}
},
"limited": {
"value": {
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"name": {
"en-US": "New Year Offer",
"de-DE": "Neujahrsangebot"
},
"items": [
"elven_sword",
"elven_boots"
],
"redeem_total_limit": 100,
"redeem_user_limit": 1,
"redeem_code_limit": 1
}
}
}
}
}
},
"personalized-catalog_create-update-body": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user-attribute_personalized-catalog-body-required"
},
"example": {
"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
}
}
}
},
"reset-user-limits": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User-limit_user"
}
}
},
"example": {
"user": {
"user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
}
}
}
}
},
"reset-user-limits-flexible": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User-limit_user_flexible"
}
}
},
"example": {
"user": {
"user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
}
}
}
}
},
"update-user-limits-flexible": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user",
"available"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User-limit_user"
},
"available": {
"$ref": "#/components/schemas/User-limit_available_flexible"
}
}
},
"example": {
"user": {
"user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
},
"available": 0
}
}
}
},
"update-user-limits-strict": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user",
"available"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User-limit_user"
},
"available": {
"$ref": "#/components/schemas/User-limit_available"
}
}
},
"example": {
"user": {
"user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
},
"available": 1
}
}
}
},
"create-value-point": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/admin_value_points-create"
},
"examples": {
"default": {
"summary": "Value point for reward chain",
"value": {
"sku": "com.xsolla.reward_vp_1",
"name": {
"en": "Reward VP 1"
},
"is_enabled": true,
"description": {
"en": "Value points for reward system."
},
"long_description": {
"en": "Value points given to users to get new rewards in a reward chain."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"media_list": [],
"order": 1
}
},
"clan": {
"summary": "Value point for clan reward chain",
"value": {
"sku": "com.xsolla.clan_value_point_1",
"name": {
"en": "Clan Reward VP 1"
},
"is_enabled": true,
"description": {
"en": "Value points for clan reward system."
},
"long_description": {
"en": "Value points given to clans to get new rewards in a reward chain."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"media_list": [],
"order": 3,
"is_clan": true
}
}
}
}
}
},
"set-item-value-point-reward": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/item-value-point-reward-set"
},
"example": [
{
"sku": "com.xsolla.booster_1",
"amount": 100
},
{
"sku": "com.xsolla.booster_mega",
"amount": 200
}
]
}
}
},
"set-item-value-point-reward-for-patch": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/item-value-point-reward-set-for-patch"
},
"example": [
{
"sku": "booster_1",
"amount": 100
},
{
"sku": "booster_mega",
"amount": 0
}
]
}
}
},
"create-reward-chain": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/create-reward-chain-model"
},
{
"$ref": "#/components/schemas/create-clan-reward-chain-model"
}
]
},
"examples": {
"default": {
"summary": "Reward chain example",
"value": {
"name": {
"en": "Reward chain"
},
"description": {
"en": "Reward chain description."
},
"long_description": {
"en": "Reward chain long description."
},
"is_enabled": true,
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"order": 1,
"periods": [
{
"date_from": "2026-01-01T01:00:00+05:00",
"date_until": "2026-01-31T23:59:59+05:00"
},
{
"date_from": "2026-02-01T01:00:00+05:00",
"date_until": "2026-02-28T23:59:59+05:00"
}
],
"value_point": {
"sku": "com.xsolla.value_point_1"
},
"steps": [
{
"name": {
"en": "First step of the reward chain"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"reward": [
{
"sku": "com.xsolla.item_1",
"quantity": 5
},
{
"sku": "com.xsolla.item_2",
"quantity": 1
}
],
"price": {
"amount": 10
}
},
{
"name": {
"en": "Second step of the reward chain"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"reward": [
{
"sku": "com.xsolla.item_3",
"quantity": 5
},
{
"sku": "com.xsolla.item_4",
"quantity": 1
}
],
"price": {
"amount": 15
}
}
],
"recurrent_schedule": {
"interval_type": "weekly",
"day_of_week": 1,
"time": "01:00:00+08:00"
},
"attribute_conditions": [
{
"attribute": "race",
"operator": "eq",
"value": "ork",
"type": "string",
"can_be_missing": false
}
],
"is_always_visible": true,
"is_reset_after_end": true
}
},
"clan": {
"summary": "Clan reward chain example",
"value": {
"name": {
"en": "Clan reward chain"
},
"description": {
"en": "Clan reward chain description."
},
"long_description": {
"en": "Clan reward chain long description."
},
"is_enabled": true,
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"order": 1,
"periods": [
{
"date_from": "2026-01-01T01:00:00+05:00",
"date_until": "2026-01-31T23:59:59+05:00"
},
{
"date_from": "2026-02-01T01:00:00+05:00",
"date_until": "2026-02-28T23:59:59+05:00"
}
],
"value_point": {
"sku": "com.xsolla.clan_value_point_1"
},
"steps": [
{
"name": {
"en": "First step of the reward chain"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"reward": [
{
"sku": "com.xsolla.item_1",
"quantity": 5
},
{
"sku": "com.xsolla.item_2",
"quantity": 1
}
],
"price": {
"amount": 10
}
},
{
"name": {
"en": "Second step of the reward chain"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"reward": [
{
"sku": "com.xsolla.item_3",
"quantity": 5
},
{
"sku": "com.xsolla.item_4",
"quantity": 1
}
],
"price": {
"amount": 15
}
}
],
"recurrent_schedule": {
"interval_type": "weekly",
"day_of_week": 1,
"time": "01:00:00+08:00"
},
"popup_header": {
"en": "How to unlock rewards"
},
"popup_instruction": {
"en": "You must be a clan member to get clan rewards. You join a clan when a clan member invites you to the clan, and you accept the invite. You can also create your own clan."
},
"popup_image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"clan_type": "guild"
}
}
}
}
}
},
"update-reward-chain": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/update-reward-chain-model"
},
{
"$ref": "#/components/schemas/update-clan-reward-chain-model"
}
]
},
"examples": {
"default": {
"summary": "Reward chain example",
"value": {
"name": {
"en": "Reward chain"
},
"description": {
"en": "Reward chain description."
},
"long_description": {
"en": "Reward chain long description."
},
"is_enabled": true,
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"order": 1,
"periods": [
{
"date_from": "2026-01-01T01:00:00+05:00",
"date_until": "2026-01-31T23:59:59+05:00"
},
{
"date_from": "2026-02-01T01:00:00+05:00",
"date_until": "2026-02-28T23:59:59+05:00"
}
],
"steps": [
{
"name": {
"en": "First step of the reward chain"
},
"step_id": 1,
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"reward": [
{
"sku": "com.xsolla.item_1",
"quantity": 5
},
{
"sku": "com.xsolla.item_2",
"quantity": 1
}
],
"price": {
"amount": 10
}
},
{
"name": {
"en": "Second step of the reward chain"
},
"step_id": 2,
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"reward": [
{
"sku": "com.xsolla.item_3",
"quantity": 5
},
{
"sku": "com.xsolla.item_4",
"quantity": 1
}
],
"price": {
"amount": 15
}
}
],
"recurrent_schedule": {
"interval_type": "weekly",
"day_of_week": 1,
"time": "01:00:00+08:00"
},
"attribute_conditions": [
{
"attribute": "race",
"operator": "eq",
"value": "ork",
"type": "string",
"can_be_missing": false
}
],
"is_always_visible": true,
"is_reset_after_end": true
}
},
"clan": {
"summary": "Clan reward chain example",
"value": {
"name": {
"en": "Clan reward chain"
},
"description": {
"en": "Clan reward chain description."
},
"long_description": {
"en": "Clan reward chain long description."
},
"is_enabled": true,
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"order": 1,
"periods": [
{
"date_from": "2026-01-01T01:00:00+05:00",
"date_until": "2026-01-31T23:59:59+05:00"
},
{
"date_from": "2026-02-01T01:00:00+05:00",
"date_until": "2026-02-28T23:59:59+05:00"
}
],
"steps": [
{
"name": {
"en": "First step of the reward chain"
},
"step_id": 1,
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"reward": [
{
"sku": "com.xsolla.item_1",
"quantity": 5
},
{
"sku": "com.xsolla.item_2",
"quantity": 1
}
],
"price": {
"amount": 10
}
},
{
"name": {
"en": "Second step of the reward chain"
},
"step_id": 2,
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"reward": [
{
"sku": "com.xsolla.item_3",
"quantity": 5
},
{
"sku": "com.xsolla.item_4",
"quantity": 1
}
],
"price": {
"amount": 15
}
}
],
"recurrent_schedule": {
"interval_type": "weekly",
"day_of_week": 1,
"time": "01:00:00+08:00"
},
"popup_header": {
"en": "How to unlock rewards"
},
"popup_instruction": {
"en": "You should be a clan member to get clan rewards. You join a clan when a clan member invited you to the clan, and you accepted the invite. You can create your own clan."
},
"popup_image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"clan_type": "guild"
}
}
}
}
}
},
"create-daily-chain": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/create-calendar-hard-daily-chain-model"
},
{
"$ref": "#/components/schemas/create-rolling-skippable-daily-chain-model"
},
{
"$ref": "#/components/schemas/create-rolling-unskippable-daily-chain-model"
}
]
},
"examples": {
"calendar_hard": {
"summary": "Daily reward with `calendar_hard` type",
"value": {
"name": {
"en": "New daily reward",
"ru": "Новая ежедневная награда"
},
"description": {
"en": "New daily reward short description"
},
"order": 4,
"date_start": "2023-04-15T18:16:00+05:00",
"is_enabled": true,
"steps": [
{
"step_number": 1,
"items": [
{
"sku": "vg_enabled_shown_in_store_1",
"quantity": 2
}
]
},
{
"step_number": 2,
"items": [
{
"sku": "bundle_enabled_shown_in_store_with_2_enabled_shown_in_store_vg",
"quantity": 2
}
]
},
{
"step_number": 3,
"items": [
{
"sku": "vcp_enabled_shown_in_store_1_of_10_vc_enabled_shown_in_store_1",
"quantity": 2
}
]
},
{
"step_number": 4,
"items": [
{
"sku": "vg_enabled_shown_in_store_1",
"quantity": 1
}
]
},
{
"step_number": 5,
"items": [
{
"sku": "bundle_enabled_shown_in_store_with_2_enabled_shown_in_store_vg",
"quantity": 1
}
]
},
{
"step_number": 6,
"items": [
{
"sku": "vcp_enabled_shown_in_store_1_of_10_vc_enabled_shown_in_store_1",
"quantity": 1
}
]
}
],
"type": "calendar_hard"
}
},
"rolling_skippable": {
"summary": "Daily reward with `rolling_skippable` type",
"value": {
"name": {
"en": "New skippable login reward"
},
"description": {
"en": "New skippable login reward short description"
},
"order": 1,
"date_start": "2023-05-01T10:00:00+05:00",
"date_end": "2023-05-31T10:00:00+05:00",
"is_enabled": true,
"is_recurrent": true,
"steps": [
{
"step_number": 1,
"items": [
{
"sku": "monday_reward_item_one",
"quantity": 1
}
]
},
{
"step_number": 2,
"items": [
{
"sku": "tuesday_reward_item_two",
"quantity": 1
}
]
},
{
"step_number": 3,
"items": [
{
"sku": "wednesday_reward_item_three",
"quantity": 1
}
]
},
{
"step_number": 4,
"items": [
{
"sku": "thursday_reward_item_four",
"quantity": 1
}
]
},
{
"step_number": 5,
"items": [
{
"sku": "friday_reward_item_five",
"quantity": 1
}
]
},
{
"step_number": 6,
"items": [
{
"sku": "saturday_reward_item_six",
"quantity": 1
}
]
},
{
"step_number": 7,
"items": [
{
"sku": "sunday_reward_item_seven",
"quantity": 1
}
]
}
],
"type": "rolling_skippable"
}
},
"rolling_unskippable": {
"summary": "Daily reward with `rolling_unskippable` type",
"value": {
"name": {
"en": "New unskippable login reward"
},
"description": {
"en": "New unskippable login reward short description"
},
"order": 2,
"date_start": "2023-06-01T10:00:00+05:00",
"date_end": "2023-06-30T10:00:00+05:00",
"is_enabled": true,
"is_recurrent": false,
"steps": [
{
"step_number": 1,
"items": [
{
"sku": "monday_reward_item_one",
"quantity": 1
}
]
},
{
"step_number": 2,
"items": [
{
"sku": "tuesday_reward_item_two",
"quantity": 1
}
]
},
{
"step_number": 3,
"items": [
{
"sku": "wednesday_reward_item_three",
"quantity": 1
}
]
},
{
"step_number": 4,
"items": [
{
"sku": "thursday_reward_item_four",
"quantity": 1
}
]
},
{
"step_number": 5,
"items": [
{
"sku": "friday_reward_item_five",
"quantity": 1
}
]
}
],
"type": "rolling_unskippable"
}
}
}
}
}
},
"update-daily-chain": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/update-calendar-hard-daily-chain-model"
},
{
"$ref": "#/components/schemas/update-rolling-skippable-daily-chain-model"
},
{
"$ref": "#/components/schemas/update-rolling-unskippable-daily-chain-model"
}
]
},
"examples": {
"calendar_hard": {
"summary": "Daily reward with `calendar_hard` type",
"value": {
"name": {
"en": "Updated daily reward",
"ru": "Обновленная ежедневная награда"
},
"description": {
"en": "Updated daily reward description"
},
"order": 4,
"date_start": "2023-04-15T18:16:00+05:00",
"is_enabled": true,
"steps": [
{
"step_number": 1,
"items": [
{
"sku": "vg_enabled_shown_in_store_1",
"quantity": 1
}
]
},
{
"step_number": 2,
"items": [
{
"sku": "vg_enabled_shown_in_store_2",
"quantity": 1
}
]
},
{
"step_id": 10,
"step_number": 3,
"items": [
{
"sku": "vg_not_shown_in_store",
"quantity": 1
}
]
},
{
"step_id": 8,
"step_number": 4,
"items": [
{
"sku": "bundle_enabled_shown_in_store_with_2_enabled_shown_in_store_vg",
"quantity": 1
}
]
},
{
"step_number": 5,
"items": [
{
"sku": "vcp_enabled_shown_in_store_1_of_10_vc_enabled_shown_in_store_1",
"quantity": 1
}
]
}
],
"type": "calendar_hard"
}
},
"rolling_skippable": {
"summary": "Daily reward with `rolling_skippable` type",
"value": {
"name": {
"en": "Updated login reward"
},
"description": {
"en": "Updated login reward description"
},
"order": 4,
"date_start": "2023-08-01T10:00:00+05:00",
"date_end": "2023-08-31T10:00:00+05:00",
"is_enabled": true,
"steps": [
{
"step_number": 1,
"items": [
{
"sku": "monday_reward_item_one",
"quantity": 1
}
]
},
{
"step_number": 2,
"items": [
{
"sku": "tuesday_reward_item_two",
"quantity": 1
}
]
},
{
"step_number": 3,
"items": [
{
"sku": "wednesday_reward_item_three",
"quantity": 1
}
]
},
{
"step_number": 4,
"items": [
{
"sku": "thursday_reward_item_four",
"quantity": 1
}
]
},
{
"step_number": 5,
"items": [
{
"sku": "friday_reward_item_five",
"quantity": 1
}
]
},
{
"step_number": 6,
"items": [
{
"sku": "saturday_reward_item_six",
"quantity": 1
}
]
},
{
"step_number": 7,
"items": [
{
"sku": "sunday_reward_item_seven",
"quantity": 1
}
]
}
],
"type": "rolling_skippable"
}
},
"rolling_unskippable": {
"summary": "Daily reward with `rolling_unskippable` type",
"value": {
"name": {
"en": "Updated unskippable login reward"
},
"description": {
"en": "Updated unskippable login reward description"
},
"order": 2,
"date_start": "2023-09-01T10:00:00+05:00",
"date_end": "2023-09-30T10:00:00+05:00",
"is_enabled": true,
"steps": [
{
"step_number": 1,
"items": [
{
"sku": "monday_reward_item_one",
"quantity": 1
}
]
},
{
"step_number": 2,
"items": [
{
"sku": "tuesday_reward_item_two",
"quantity": 1
}
]
},
{
"step_number": 3,
"items": [
{
"sku": "wednesday_reward_item_three",
"quantity": 1
}
]
},
{
"step_number": 4,
"items": [
{
"sku": "thursday_reward_item_four",
"quantity": 1
}
]
},
{
"step_number": 5,
"items": [
{
"sku": "friday_reward_item_five",
"quantity": 1
}
]
}
],
"type": "rolling_unskippable"
}
}
}
}
}
},
"create-offer-chain": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/create-offer-chain-model"
},
"examples": {
"default": {
"summary": "Non-personalized offer chain example",
"value": {
"name": {
"en": "New offer chain",
"ru": "Новая цепочка предложений",
"de": "Neue Angebotskette",
"fr": "Nouvelle chaîne d'offres",
"it": "Nuova catena di offerte"
},
"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_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_number": 4,
"is_free": true,
"items": [
{
"sku": "chain_step_4_free_bundle_sku",
"quantity": 1
}
]
}
],
"is_always_visible": true
}
},
"recurrent": {
"summary": "Recurrent offer chain example",
"value": {
"name": {
"en": "New recurrent offer chain",
"ru": "Новая рекуррентная цепочка предложений",
"de": "Neue wiederkehrende Angebotskette",
"fr": "Nouvelle chaîne d'offres récurrente",
"it": "Nuova catena di offerte ricorrente"
},
"description": {
"en": "A recurring offer chain that resets weekly on Wednesdays at 07:00 AM GMT+3",
"ru": "Рекуррентная цепочка предложений, которая сбрасывается еженедельно по средам в 07:00 по GMT+3",
"de": "Eine wiederkehrende Angebotskette, die wöchentlich mittwochs um 07:00 Uhr GMT+3 zurückgesetzt wird",
"fr": "Une chaîne d'offres récurrente qui se réinitialise chaque semaine le mercredi à 07h00 GMT+3",
"it": "Una catena di offerte ricorrente che si resetta settimanalmente il mercoledì alle 07:00 GMT+3"
},
"order": 1,
"date_start": "2023-04-15T18:16:00+05:00",
"date_end": "2025-04-25T18:16:00+05:00",
"is_enabled": false,
"recurrent_schedule": {
"interval_type": "weekly",
"day_of_week": 3,
"time": "07:00:00+03:00"
},
"steps": [
{
"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": 3
}
]
}
],
"is_always_visible": true
}
},
"personalized-default": {
"summary": "Offer chain displayed when no personalized offer chains are found example",
"value": {
"name": {
"en": "New personalized default offer chain",
"ru": "Новая персонализированная цепочка предложений по умолчанию",
"de": "Neue personalisierte Standard-Angebotskette",
"fr": "Nouvelle chaîne d'offres personnalisée par défaut",
"it": "Nuova catena di offerte personalizzata predefinita"
},
"description": {
"en": "Default personalized offer chain for users that do not meet the conditions of other personalized chains",
"ru": "Персонализированная цепочка по умолчанию для пользователей, не подходящих под условия других персонализированных цепочек",
"de": "Standard-personalisierte Angebotskette für Benutzer, die die Bedingungen anderer personalisierter Ketten nicht erfüllen",
"fr": "Chaîne d'offres personnalisée par défaut pour les utilisateurs qui ne répondent pas aux conditions des autres chaînes personnalisées",
"it": "Catena di offerte personalizzata predefinita per gli utenti che non soddisfano le condizioni di altre catene personalizzate"
},
"order": 4,
"date_start": "2023-04-15T18:16:00+05:00",
"date_end": null,
"recurrent_schedule": null,
"is_enabled": true,
"steps": [
{
"step_number": 1,
"is_free": false,
"items": [
{
"sku": "chain_x_step_1_item_default",
"quantity": 1
}
]
},
{
"step_number": 2,
"is_free": false,
"items": [
{
"sku": "chain_x_step_2_item_default",
"quantity": 2
}
]
},
{
"step_number": 3,
"is_free": true,
"items": [
{
"sku": "chain_x_step_3_free_item_default",
"quantity": 1
}
]
}
],
"is_always_visible": false
}
},
"personalized-with-conditions": {
"summary": "Personalized offer chain with user attribute conditions example",
"value": {
"name": {
"en": "New personalized offer chain",
"ru": "Новая персонализированная цепочка предложений",
"de": "Neue personalisierte Angebotskette",
"fr": "Nouvelle chaîne d'offres personnalisée",
"it": "Nuova catena di offerte personalizzata"
},
"description": {
"en": "Personalized offer chain with user attribute conditions - for level 10 and above elves who reached level 10 no later than 2026-01-01 00:00:00, inclusive",
"ru": "Персонализированная цепочка предложений с условиями по атрибутам пользователя - для эльфов уровня 10 и выше, достигших 10 уровня не позднее 2026-01-01 00:00:00 включительно",
"de": "Personalisierte Angebotskette mit Benutzerattributbedingungen - für Elfen der Stufe 10 und höher, die Stufe 10 spätestens am 2026-01-01 00:00:00 erreicht haben, einschließlich",
"fr": "Chaîne d'offres personnalisée avec des conditions d'attribut utilisateur - pour les elfes de niveau 10 et plus qui ont atteint le niveau 10 au plus tard le 2026-01-01 00:00:00, inclus",
"it": "Catena di offerte personalizzata con condizioni di attributo utente - per elfi di livello 10 e superiore che hanno raggiunto il livello 10 non più tardi del 2026-01-01 00:00:00, inclusi"
},
"order": 4,
"date_start": "2023-04-15T18:16:00+05:00",
"date_end": null,
"recurrent_schedule": null,
"is_enabled": true,
"steps": [
{
"step_number": 1,
"is_free": false,
"items": [
{
"sku": "chain_x_step_1_item_for_elves_level_10_and_above",
"quantity": 1
}
]
},
{
"step_number": 2,
"is_free": false,
"items": [
{
"sku": "chain_x_step_2_item_for_elves_level_10_and_above",
"quantity": 2
}
]
},
{
"step_number": 3,
"is_free": true,
"items": [
{
"sku": "chain_x_step_3_free_item_for_elves_level_10_and_above",
"quantity": 1
}
]
}
],
"is_always_visible": false,
"attribute_conditions": [
{
"attribute": "race",
"operator": "eq",
"value": "elf",
"type": "string",
"can_be_missing": false
},
{
"attribute": "level",
"operator": "ge",
"value": "10",
"type": "number",
"can_be_missing": false
},
{
"attribute": "10_level_up_date",
"operator": "le",
"value": "2026-01-01T00:00:00",
"type": "date",
"can_be_missing": false
}
]
}
}
}
}
}
},
"update-offer-chain": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/modify-offer-chain-model"
},
"examples": {
"default": {
"summary": "Default example",
"value": {
"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
}
},
"recurrent": {
"summary": "Recurrent offer chain example",
"value": {
"id": 1,
"name": {
"en": "Updated recurrent offer chain",
"ru": "Обновляемая рекуррентная цепочка предложений",
"de": "Aktualisierte wiederkehrende Angebotskette",
"fr": "Chaîne d'offres récurrente mise à jour",
"it": "Catena di offerte ricorrente aggiornata"
},
"description": {
"en": "Updated offer chain that becomes recurrent and resets monthly on the 2nd day at 03:00 AM GMT+8",
"ru": "Обновляемая цепочка предложений, которая становится рекуррентной и сбрасывается ежемесячно во 2-й день в 03:00 по GMT+8",
"de": "Aktualisierte Angebotskette, die wiederkehrend wird und monatlich am 2. Tag um 03:00 Uhr GMT+8 zurückgesetzt wird",
"fr": "Chaîne d'offres mise à jour qui devient récurrente et se réinitialise mensuellement le 2e jour à 03h00 GMT+8",
"it": "Catena di offerte aggiornata che diventa ricorrente e si resetta mensilmente il 2° giorno alle 03:00 GMT+8"
},
"order": 4,
"date_start": "2023-04-15T17:16:00+05:00",
"date_end": "2025-04-25T19:16:00+05:00",
"is_enabled": true,
"recurrent_schedule": {
"interval_type": "monthly",
"day_of_month": 2,
"time": "03:00:00+08:00"
},
"steps": [
{
"step_number": 1,
"is_free": false,
"items": [
{
"sku": "chain_bundle_sku",
"quantity": 6
}
]
},
{
"step_number": 1,
"is_free": true,
"items": [
{
"sku": "chain_bundle_sku",
"quantity": 2
}
]
}
]
}
},
"personalized-default": {
"summary": "Personalized default offer chain example",
"value": {
"name": {
"en": "New personalized default offer chain",
"ru": "Новая персонализированная цепочка предложений по умолчанию",
"de": "Neue personalisierte Standard-Angebotskette",
"fr": "Nouvelle chaîne d'offres personnalisée par défaut",
"it": "Nuova catena di offerte personalizzata predefinita"
},
"description": {
"en": "Default personalized offer chain for users that do not meet the conditions of other personalized chains",
"ru": "Персонализированная цепочка по умолчанию для пользователей, не подходящих под условия других персонализированных цепочек",
"de": "Standard-personalisierte Angebotskette für Benutzer, die die Bedingungen anderer personalisierter Ketten nicht erfüllen",
"fr": "Chaîne d'offres personnalisée par défaut pour les utilisateurs qui ne répondent pas aux conditions des autres chaînes personnalisées",
"it": "Catena di offerte personalizzata predefinita per gli utenti che non soddisfano le condizioni di altre catene personalizzate"
},
"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_x_step_1_item_default",
"quantity": 1
}
]
},
{
"step_number": 2,
"is_free": false,
"items": [
{
"sku": "chain_x_step_2_item_default",
"quantity": 2
}
]
},
{
"step_id": 9,
"step_number": 3,
"is_free": true,
"items": [
{
"sku": "chain_x_step_3_free_item_default",
"quantity": 1
}
]
}
],
"is_always_visible": false
}
},
"personalized-with-conditions": {
"summary": "Personalized offer chain with user attribute conditions example",
"value": {
"name": {
"en": "New personalized offer chain",
"ru": "Новая персонализированная цепочка предложений",
"de": "Neue personalisierte Angebotskette",
"fr": "Nouvelle chaîne d'offres personnalisée",
"it": "Nuova catena di offerte personalizzata"
},
"description": {
"en": "Personalized offer chain with user attribute conditions - for level 10 and above elves who reached level 10 no later than 2026-01-01 00:00:00, inclusive",
"ru": "Персонализированная цепочка предложений с условиями по атрибутам пользователя - для эльфов уровня 10 и выше, достигших 10 уровня не позднее 2026-01-01 00:00:00 включительно",
"de": "Personalisierte Angebotskette mit Benutzerattributbedingungen - für Elfen der Stufe 10 und höher, die Stufe 10 spätestens am 2026-01-01 00:00:00 erreicht haben, einschließlich",
"fr": "Chaîne d'offres personnalisée avec des conditions d'attribut utilisateur - pour les elfes de niveau 10 et plus qui ont atteint le niveau 10 au plus tard le 2026-01-01 00:00:00, inclus",
"it": "Catena di offerte personalizzata con condizioni di attributo utente - per elfi di livello 10 e superiore che hanno raggiunto il livello 10 non più tardi del 2026-01-01 00:00:00, inclusi"
},
"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_x_step_1_item_for_elves_level_10_and_above",
"quantity": 1
}
]
},
{
"step_id": 8,
"step_number": 2,
"is_free": false,
"items": [
{
"sku": "chain_x_step_2_item_for_elves_level_10_and_above",
"quantity": 2
}
]
},
{
"step_number": 3,
"is_free": true,
"items": [
{
"sku": "chain_x_step_3_free_item_for_elves_level_10_and_above",
"quantity": 1
}
]
}
],
"is_always_visible": false,
"attribute_conditions": [
{
"attribute": "race",
"operator": "eq",
"value": "elf",
"type": "string",
"can_be_missing": false
},
{
"attribute": "level",
"operator": "ge",
"value": "10",
"type": "number",
"can_be_missing": false
},
{
"attribute": "10_level_up_date",
"operator": "le",
"value": "2026-01-01T00:00:00",
"type": "date",
"can_be_missing": false
}
]
}
}
}
}
}
},
"update-upsell": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Upsell-model"
},
{
"$ref": "#/components/schemas/Upsell-model-not-fixed-list"
}
]
},
"examples": {
"fixed_list": {
"summary": "Example of upsell with fixed list of items",
"value": {
"is_enabled": true,
"type": "fixed_list",
"items": [
"game_sku_1",
"game_sku_2",
"game_sku_3"
]
}
},
"special_type_promotions": {
"summary": "Example of upsell with promotion items only",
"value": {
"is_enabled": true,
"type": "only_promotions",
"items": []
}
},
"special_type_most_sellable": {
"summary": "Example of upsell with most sellable items for last 30 days",
"value": {
"is_enabled": true,
"type": "most_sellable",
"items": []
}
}
}
}
}
},
"create-upsell": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Upsell-model"
},
{
"$ref": "#/components/schemas/Upsell-model-not-fixed-list"
}
]
},
"examples": {
"fixed_list": {
"summary": "Example of upsell with fixed list of items",
"value": {
"is_enabled": true,
"type": "fixed_list",
"items": [
"game_sku_1",
"game_sku_2",
"game_sku_3"
]
}
},
"special_type_promotions": {
"summary": "Example of upsell with promotion items only",
"value": {
"is_enabled": true,
"type": "only_promotions",
"items": []
}
},
"special_type_most_sellable": {
"summary": "Example of upsell with most sellable items for last 30 days",
"value": {
"is_enabled": true,
"type": "most_sellable",
"items": []
}
}
}
}
}
},
"debit-point-balance": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"amount",
"reason"
],
"properties": {
"amount": {
"type": "number",
"format": "double",
"description": "Количество списываемых баллов лояльности. Значение должно быть больше 0.",
"example": 50
},
"reason": {
"type": "string",
"description": "Причина изменения баланса в свободной форме (например: вознаграждение, компенсация, ручная корректировка).",
"example": "Manual adjustment"
}
}
},
"examples": {
"request": {
"value": {
"amount": 50,
"reason": "Manual adjustment"
}
}
}
}
}
},
"credit-point-balance": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"amount",
"reason"
],
"properties": {
"amount": {
"type": "number",
"format": "double",
"description": "Количество начисляемых баллов лояльности. Значение должно быть больше 0.",
"example": 50
},
"reason": {
"type": "string",
"description": "Причина изменения баланса в свободной форме (например: вознаграждение, компенсация, ручная корректировка).",
"example": "Manual adjustment"
}
}
},
"examples": {
"request": {
"value": {
"amount": 50,
"reason": "Manual adjustment"
}
}
}
}
}
}
}
},
"x-tagGroups": [
{
"name": "АКЦИИ",
"tags": [
"promotions-overview",
"promotions-common",
"promotions-coupons",
"promotions-promo-codes",
"promotions-unique-catalog-offers",
"promotions-discounts",
"promotions-bonuses"
]
},
{
"name": "ПЕРСОНАЛИЗАЦИЯ",
"tags": [
"personalized-catalog"
]
},
{
"name": "ЛИМИТЫ",
"tags": [
"promotion-limits-overview",
"user-limits-admin"
]
},
{
"name": "ЦЕПОЧКИ НАГРАД И ПРИЗОВЫЕ БАЛЛЫ",
"tags": [
"reward-chain-value-points-overview",
"reward-chain-value-points-admin",
"reward-chain-client",
"clan-reward-chain-client"
]
},
{
"name": "ЕЖЕДНЕВНЫЕ ЦЕПОЧКИ",
"tags": [
"daily-chain-overview",
"daily-chain-admin",
"daily-chain-client"
]
},
{
"name": "ЦЕПОЧКИ ПРЕДЛОЖЕНИЙ",
"tags": [
"offer-chains-overview",
"offer-chain-admin",
"offer-chain-client"
]
},
{
"name": "UPSELL",
"tags": [
"upsell-overview",
"upsell-admin",
"upsell-client"
]
},
{
"name": "LOYALTY AS SERVICE",
"tags": [
"loyalty-program-overview",
"loyalty-program-admin",
"loyalty-program-client"
]
}
]
}