` — токен пользователя. Токен идентифицирует пользователя и обеспечивает доступ к персонализированным данным.\nВ качестве альтернативы вы можете использовать [токен для открытия платежного интерфейса](/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## Полезные ссылки {% #authentication-useful-links %}\n\n- [Методы API по модели взаимодействия](/ru/api/getting-started/#api_interaction_model)\n- [Типы эндпоинтов](/ru/api/getting-started/#api_endpoint_types)\n- [Обработка ошибок](/ru/api/getting-started/#api_errors_handling)\n- [Управление ключами API](/ru/api/getting-started/#api_keys_overview)\n- [Вебхуки](/ru/webhooks/overview)\n\n# Базовая структура товара {% #core-entity-structure %}\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# Настройка продажи товаров {% #basic-purchase-flow %}\n\nXsolla API позволяет реализовать логику магазина внутриигровых товаров, включая получение каталога, управление корзиной, создание заказов и отслеживание их статусов. В зависимости от сценария интеграции методы API делятся на подразделы **Admin** и **Catalog**, которые используют разные [схемы аутентификации](/ru/api/catalog/authentication).\n\nНиже приведен пример базового сценария настройки и работы магазина — от создания товаров до их продажи пользователю.\n\n## Создание товаров и групп (Admin) {% #create-items-and-groups-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) {% #set-up-promotions-chains-and-limits-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) {% #get-item-information-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## Продажа товаров {% #sell-items %}\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### Быстрая покупка {% #fast-purchase %}\n\nИспользуйте клиентский [метод создания заказа с указанным товаром](/ru/api/catalog/payment-client-side/create-order-with-item) – в ответе вы получите токен, который используется для открытия платежного интерфейса.\n\n\n Примечание
\n Информация о скидке доступна пользователю только в платежном интерфейсе. Использование промокодов не предусмотрено.\n
\n\n### Покупка корзины {% #cart-purchase %}\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## Открытие платежного интерфейса {% #open-payment-ui %}\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 страна определяется по IP-адресу запроса.
\n - В серверных методах,\n страна определяется по значению параметра
user.country.value или по IP-адресу пользователя из заголовка X-User-Ip. Если переданы оба значения, приоритет имеет параметр user.country.value. \n
\n\n\n
Примечание\n Для определения страны поддерживаются только
IPv4-адреса.\n Передача
IPv6-адреса может привести к некорректному определению страны и валюты. Если вы используете серверный метод и не можете передать IPv4-адрес пользователя, передайте страну явно в параметре
user.country.value.\n
\n Уведомление
\n Не используйте методы подраздела Admin для построения каталога пользователям.\n
\n\n
\n\n\n
Примечание\n Метод
Получение списка виртуальных предметов возвращает подробные данные о предметах, включая цены и атрибуты, и поддерживает пагинацию — используйте его для отображения страниц каталога в витрине магазина.\n
\n Метод
Получение списка всех виртуальных предметов возвращает артикул, название и описание предмета, а также ID и название группы без пагинации — используйте его для поиска или индексирования на стороне клиента.\n
\n\nДля реализации покупок за виртуальную валюту используйте метод [Создание заказа с указанным товаром, приобретенным за виртуальную валюту](/ru/api/catalog/virtual-payment/create-order-with-item-for-virtual-currency). Открывать платежный интерфейс не нужно — списание происходит в момент вызова метода.\n\nПример сценария покупки товара за виртуальную валюту:\n\n"
},
{
"name": "virtual-items-currency-admin",
"x-displayName": "Admin"
},
{
"name": "virtual-items-currency-catalog",
"x-displayName": "Catalog"
},
{
"name": "virtual-payment",
"x-displayName": "Виртуальная оплата"
},
{
"name": "game-keys-overview",
"x-displayName": "Основная информация",
"description": "Игровые ключи — это разовые уникальные буквенно‑цифровые коды, которые дают пользователю доступ к игре или DLC на игровых платформах. Продажа игровых ключей возможна [по прямой ссылке](/ru/sell-games/set-up-selling-game-keys/#guides_game_sales_selling_game_keys_selling_via_direct_link), [через интерфейс магазина](/ru/sell-games/set-up-selling-game-keys/#guides_game_sales_selling_game_keys_selling_via_store_ui) или [через виджет](/ru/sell-games/set-up-selling-game-keys/#guides_game_sales_selling_items_develop_buttons). Вы также можете настроить [региональные ограничения](/ru/items-catalog/catalog-features/regional-restrictions/), чтобы продавать игровые ключи в определенных странах. Подробная информация об игровых ключах доступна в разделе [Пакеты игровых ключей](https://developers.xsolla.com/ru/items-catalog/items-type/set-up-modules/).\n\nДля продажи игровых ключей аутентификация пользователей не требуется — ключи отправляются пользователю на указанный при покупке email-адрес. Настройка аутентификации обязательна, чтобы реализовать дополнительные сценарии: [настроить персонализацию](/ru/liveops/liveops-management/personalization-tutorial/), [ограничения на покупку](/ru/items-catalog/catalog-features/items-catalog-number-limits/) или [систему владения играми](/ru/sell-games/how-to/entitlement-system/). Подробная информация доступна в разделе [Как настроить аутентификацию для продажи игровых ключей](/ru/sell-games/how-to/set-up-authentication/).\n\nСценарий продажи игровых ключей:\n\n1. Создайте игру с помощью метода API [Создание игры](/ru/api/catalog/game-keys-admin/admin-create-game).\n2. Настройте региональные ограничения.\n3. Загрузите ключи в пакет игровых ключей с помощью метода API [Загрузка кодов](/ru/api/catalog/game-keys-admin/admin-upload-codes-by-sku), чтобы продавать их пользователям.\n4. Отобразите пользователю каталог игр с ценами для его региона с помощью метода API [Получение списка игр](/ru/api/catalog/game-keys-catalog/get-games-list).\n5. Сформируйте заказ. Например, для быстрой покупки вы можете использовать метод API [Создание заказа с указанным товаром](/ru/api/catalog/payment-client-side/create-order-with-item), передав артикул игрового ключа. В ответе вы получите токен для открытия платежного интерфейса.\n6. Реализуйте открытие платежного интерфейса для оплаты заказа.\n\nНастройте отслеживание статуса заказа, например с помощью [вебхуков](/ru/webhooks/overview), чтобы своевременно получать данные об успешно оплаченных товарах и начислять их пользователю. Ключи отправляются пользователю на указанный при покупке email-адрес, после этого заказ переходит в статус `done`.\n\n"
},
{
"name": "game-keys-catalog",
"x-displayName": "Catalog"
},
{
"name": "game-keys-entitlement",
"x-displayName": "Владение играми"
},
{
"name": "game-keys-admin",
"x-displayName": "Admin"
},
{
"name": "bundles-overview",
"x-displayName": "Основная информация",
"description": "Бандл — набор товаров, который продается как единое целое. В состав бандла можно добавить виртуальные предметы, виртуальную валюту, пакеты виртуальной валюты, игровые ключи и другие бандлы. Используйте бандлы для создания стартовых наборов, сезонных предложений и специальных предложений.\n\nИспользуйте следующие группы методов API для работы с бандлами:\n\n* Admin — для создания, обновления, удаления бандлов и управления их видимостью.\n* Catalog — для получения списка бандлов.\n\nЛимит на количество покупок настраивается с помощью объекта `limits` при создании или обновлении бандла. Подробная информация приведена в разделе [Лимиты](/ru/api/catalog/limits-overview). Вы также можете настроить [региональные ограничения](https://developers.xsolla.com/ru/items-catalog/catalog-features/regional-restrictions/), чтобы продавать товары в определенных странах.\n\n Внимание Подробная информация о настройке бандлов приведена в разделе
Бандлы.
\n\n
\n\nСценарий работы с бандлами:\n\n1. Создайте бандл с помощью метода API [Создание бандла](/ru/api/catalog/bundles-admin/admin-create-bundle). Чтобы проверить созданный бандл, используйте метод API [Получение бандла](/ru/api/catalog/bundles-admin/admin-get-bundle). Чтобы получить список всех бандлов в проекте, используйте метод API [Получение списка бандлов](/ru/api/catalog/bundles-admin/admin-get-bundle-list).\n2. При необходимости используйте метод API [Обновление бандла](/ru/api/catalog/bundles-admin/admin-update-bundle) для для изменения его состава или настроек.\n3. Реализуйте логику отображения бандлов в магазине с помощью методов API [Получение списка бандлов](/ru/api/catalog/bundles-catalog/get-bundle-list), [Получение указанного бандла](/ru/api/catalog/bundles-catalog/get-bundle) или [Получение списка бандлов по указанной группе](/ru/api/catalog/bundles-catalog/get-bundle-list-in-group).\n4. Сформируйте заказ, используя методы раздела [Корзина и оплата](/ru/api/catalog/cart-and-payment-overview). Например, для быстрой покупки вы можете использовать метод API [Создание заказа с указанным товаром](/ru/api/catalog/payment-client-side/create-order-with-item), передав артикул бандла. В ответе вы получите токен для открытия платежного интерфейса.\n5. Реализуйте открытие платежного интерфейса для оплаты заказа.\n6. Настройте отслеживание статуса заказа, например с помощью [вебхуков](https://developers.xsolla.com/ru/webhooks/overview), чтобы своевременно получать данные об успешно оплаченных товарах и начислять их пользователю.\n\n"
},
{
"name": "bundles-admin",
"x-displayName": "Admin"
},
{
"name": "bundles-catalog",
"x-displayName": "Catalog"
},
{
"name": "cart-and-payment-overview",
"x-displayName": "Основная информация",
"description": "Корзина — это механизм покупки, который позволяет объединять несколько товаров в одном заказе. Пользователь может купить товары любого типа в любом количестве за реальную валюту, а также использовать [промокоды](https://developers.xsolla.com/ru/api/liveops/promotions-promo-codes).\n\nКорзина хранится на стороне Xsolla. Сохранение корзины между сессиями зависит от того, авторизован ли пользователь:\n * Для авторизованных пользователей корзина привязана к конкретному пользователю и сохраняется между сессиями, пока запросы выполняются от имени того же пользователя.\n\n * Для [неавторизованных пользователей](/ru/api/catalog/authentication-with-guest-access-support) сохранение корзины зависит от передачи заголовка `x-unauthorized-id`. Чтобы сохранить корзину неавторизованного пользователя между сессиями, передавайте один и тот же `x-unauthorized-id` в каждом запросе. Этот вариант доступен только при продаже игровых ключей.\n\nВы можете идентифицировать корзину двумя способами: автоматически по [JWT пользователя](https://developers.xsolla.com/ru/api/catalog/authentication-using-users-jwt) или по ID корзины (`cart_id`).\n\nУправление корзиной доступно как на стороне клиента, так и на стороне сервера.\n\nНа стороне сервера вы можете наполнить корзину товарами, например при восстановлении сессии пользователя. На стороне клиента доступны следующие действия:\n\n* получить корзину текущего пользователя или по ID корзины;\n* наполнить корзину;\n* обновить товары в корзине;\n* удалить товары из корзины.\n\nДля оплаты товаров из корзины используются клиентские и серверные методы создания заказа.\n\nПо умолчанию время жизни корзины — 72 часа. Если состав корзины изменился, например при добавлении нового товара, ее время жизни продлевается.\n\nПосле успешной оплаты корзина не очищается автоматически. Чтобы очистить корзину, используйте следующие клиентские методы API:\n * [Удаление всех товаров из корзины по ID корзины](/ru/api/catalog/cart-client-side/cart-clear-by-id).\n\n * [Удаление всех товаров из текущей корзины](/ru/api/catalog/cart-client-side/cart-clear).\n\n * [Удаление товара из корзины по ID корзины](/ru/api/catalog/cart-client-side/delete-item-by-cart-id) и [Удаление товара из текущей корзины](/ru/api/catalog/cart-client-side/delete-item) — корзина очищается, когда вы удаляете последний товар из нее.\n\nСценарий использования корзины:\n\n1. Реализуйте интерфейс магазина, в котором пользователь будет выбирать товары.\n\n2. Когда пользователь выбирает товары в магазине, добавьте их в корзину, например с помощью метода [Наполнение корзины товарами](https://developers.xsolla.com/ru/api/catalog/cart-client-side/cart-fill). В массиве items необходимо передать артикулы и количество необходимых товаров.\n\n3. Реализуйте интерфейс просмотра корзины. При переходе пользователя в корзину отобразите ее содержимое с помощью метода [Получение корзины текущего пользователя](https://developers.xsolla.com/ru/api/catalog/cart-client-side/get-user-cart). В ответе отобразится информация об итоговой цене товаров с учетом скидок, а также примененных акциях.\n\n4. Реализуйте открытие платежного интерфейса для оплаты заказа. Например, вы можете вызвать метод [Создание заказа со всеми товарами из определенной корзины](https://developers.xsolla.com/ru/api/catalog/payment-client-side/create-order-by-cart-id). В ответе вы получите токен для открытия платежного интерфейса.\n\n5. Настройте отслеживание статуса заказа, например с помощью [вебхуков](https://developers.xsolla.com/ru/webhooks/), чтобы своевременно получать данные об успешно оплаченных товарах и начислять их пользователю.\n\n\n\n"
},
{
"name": "order-life-cycle",
"x-displayName": "Жизненный цикл заказа",
"description": "Понимание жизненного цикла заказа поможет вам при настройке его [отслеживания](https://developers.xsolla.com/ru/virtual-goods/own-ui/client-side-token-generation/set-up-order-tracking/?tabs=100-trackOrderOnClient_200-api&_xm=4170963201673921623), например, чтобы начислить товары пользователю после успешной оплаты.\n\nЗаказ переходит по следующим статусам:\n\n\n \n \n | Статус | \n Описание | \n Примечание | \n
\n \n \n \n new | \n Заказ создан. Система ожидает подтверждение оплаты. | \n Описания статусов транзакций приведены в документации Pay Station API. | \n
\n \n paid | \n Заказ оплачен (транзакция перешла в статус done), и товар может быть начислен пользователю. | \n Пока заказ не оплачен, он находится в статусе new. | \n
\n \n done | \n Товар из заказа начислен пользователю. | \n — | \n
\n \n canceled | \n Пользователь оформил возврат платежа. | \n Заказ переходит в этот статус, когда статус транзакции меняется на refunded. | \n
\n \n expired | \n Если новый заказ включает в себя товар, промокод или акцию, на которые настроены ограничения, предыдущий неоплаченный заказ с этим же товаром переходит в статус expired. Пользователь может оплатить только последний созданный заказ. | \n Если пользователь пытается оплатить заказ, который находится в этом статусе, в платежном интерфейсе он увидит ошибку 2002 и не сможет совершить платеж. | \n
\n \n
\n\n\n\n\n
Примечание
\n
Если в процессе оплаты заказ перешел в статус expired, но пользователь успешно завершил платеж, заказ переходит из статуса expired в paid. Это возможно только если при оплате такого заказа не будет превышен лимит на покупку товара.
\n
\n Примечание
\nXsolla проверяет, входит ли страна пользователя в регион, указанный у товара. Если страна не входит в регион товара, создание заказа будет недоступно.\n
\n\n
\n\n5. Реализуйте открытие платежного интерфейса для оплаты заказа.\n\n"
},
{
"name": "attribute-admin",
"x-displayName": "Admin"
},
{
"name": "item-groups-admin",
"x-displayName": "Admin"
},
{
"name": "item-groups-catalog",
"x-displayName": "Catalog"
},
{
"name": "common-webhooks",
"x-displayName": "Вебхуки"
}
],
"paths": {
"/v2/project/{project_id}/admin/items/virtual_items": {
"get": {
"summary": "Получение списка виртуальных предметов",
"description": "Получает список виртуальных предметов в рамках проекта для администрирования.\n\nПримечание
Не используйте данный метод для построения каталога магазина.
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"operationId": "admin-get-virtual-items-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-items"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
},
"post": {
"summary": "Создание виртуального предмета",
"description": "Создает виртуальный предмет.",
"security": [
{
"basicAuth": []
}
],
"operationId": "admin-create-virtual-item",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"requestBody": {
"description": "\n Примечание
\n Схема тела запроса содержит опциональные параметры для продвинутых сценариев, таких как настройка региональных цен, лимитов на покупку или ограничения времени отображения. Для создания базового предмета достаточно указать параметры sku, name, и description. Чтобы задать цены в реальной валюте, передайте параметр prices, в виртуальной — vc_prices, или установите is_free: true, чтобы предмет был бесплатным.\n
\n\n
",
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-item"
},
"responses": {
"201": {
"$ref": "#/components/responses/Virtual-Items-Currency_201-created"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_items/group/external_id/{external_id}": {
"get": {
"summary": "Получение списка виртуальных предметов по указанному External ID группы",
"description": "Получает список виртуальных предметов в рамках группы для администрирования.\n\nПримечание
Не используйте данный метод для построения каталога магазина.
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"operationId": "admin-get-virtual-items-list-by-group-external-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-items-by-group"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_items/group/id/{group_id}": {
"get": {
"summary": "Получение списка виртуальных предметов по указанному ID группы",
"description": "Получает список виртуальных предметов в рамках группы для администрирования.\n\nПримечание
Не используйте данный метод для построения каталога магазина.
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/group_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"operationId": "admin-get-virtual-items-list-by-group-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-items-by-group"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_items/sku/{item_sku}": {
"get": {
"summary": "Получение виртуального предмета",
"description": "Получает виртуальный предмет в рамках проекта для администрирования.\n\nПримечание
Не используйте данный метод для построения каталога магазина.
",
"operationId": "admin-get-virtual-item",
"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": [
"virtual-items-currency-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-item"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
},
"put": {
"summary": "Обновление виртуального предмета",
"description": "Обновляет виртуальный предмет.",
"operationId": "admin-update-virtual-item",
"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": [
"virtual-items-currency-admin"
],
"requestBody": {
"description": "\n Примечание
\n Схема тела запроса содержит как обязательные, так и опциональные параметры для продвинутых сценариев, таких как настройка региональных цен, лимитов на покупку или ограничения времени отображения.\n
\n\n
\n\n\n Внимание
\n Передавайте все параметры предмета, включая те, которые не требуется обновлять. Параметры, отсутствующие в запросе, будут удалены.\n
\n\n
",
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-item"
},
"responses": {
"204": {
"description": "Виртуальный предмет обновлен успешно.",
"content": {}
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
},
"delete": {
"summary": "Удаление виртуального предмета",
"description": "Удаляет виртуальный предмет.",
"operationId": "admin-delete-virtual-item",
"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": [
"virtual-items-currency-admin"
],
"responses": {
"204": {
"description": "Виртуальный предмет удален успешно.",
"content": {}
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_currency": {
"get": {
"summary": "Получение списка виртуальных валют",
"description": "Получает список виртуальных валют в рамках проекта для администрирования.\n\nПримечание
Не используйте данный метод для построения каталога магазина.
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"operationId": "admin-get-virtual-currencies-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currencies"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
},
"post": {
"summary": "Создание виртуальной валюты",
"operationId": "admin-create-virtual-currency",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"description": "Создает виртуальную валюту.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency"
},
"responses": {
"201": {
"$ref": "#/components/responses/Virtual-Items-Currency_201-created"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_currency/sku/{virtual_currency_sku}": {
"get": {
"summary": "Получение виртуальной валюты",
"description": "Получает виртуальную валюту в рамках проекта для администрирования.\n\nПримечание
Не используйте данный метод для построения каталога магазина.
",
"operationId": "admin-get-virtual-currency",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"virtual-items-currency-admin"
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/virtual_currency_sku-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currency"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Virtual-Items-Currency_404-item"
}
}
},
"put": {
"summary": "Обновление виртуальной валюты",
"description": "Обновляет виртуальную валюту.",
"operationId": "admin-update-virtual-currency",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/virtual_currency_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency"
},
"responses": {
"204": {
"description": "Виртуальная валюта обновлена успешно.",
"content": {}
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
},
"delete": {
"summary": "Удаление виртуальной валюты",
"description": "Удаляет виртуальную валюту.",
"operationId": "admin-delete-virtual-currency",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/virtual_currency_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"responses": {
"204": {
"description": "Виртуальная валюта удалена успешно.",
"content": {}
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_currency/package": {
"get": {
"summary": "Получение списка пакетов виртуальной валюты (admin)",
"description": "Получает список пакетов виртуальной валюты в рамках проекта для администрирования.\n\nПримечание
Не используйте данный метод для построения каталога магазина.
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"operationId": "admin-get-virtual-currency-packages-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currency-packages"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
},
"post": {
"summary": "Создание пакета виртуальной валюты",
"description": "Создает пакет виртуальной валюты.",
"security": [
{
"basicAuth": []
}
],
"operationId": "admin-create-virtual-currency-package",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency-package"
},
"responses": {
"201": {
"$ref": "#/components/responses/Virtual-Items-Currency_201-created"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_currency/package/sku/{item_sku}": {
"put": {
"summary": "Обновление пакета виртуальной валюты",
"description": "Обновляет пакет виртуальной валюты.",
"operationId": "admin-update-virtual-currency-package",
"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": [
"virtual-items-currency-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency-package"
},
"responses": {
"204": {
"description": "Виртуальный предмет обновлен успешно."
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
},
"delete": {
"summary": "Удаление пакета виртуальной валюты",
"description": "Удаляет пакет виртуальной валюты.",
"operationId": "admin-delete-virtual-currency-package",
"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": [
"virtual-items-currency-admin"
],
"responses": {
"204": {
"description": "Пакет виртуальной валюты обновлен успешно."
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
},
"get": {
"summary": "Получение пакета виртуальной валюты",
"description": "Получает пакет виртуальной валюты в рамках проекта для администрирования.\n\nПримечание
Не используйте данный метод для построения каталога магазина.
",
"operationId": "admin-get-virtual-currency-package",
"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": [
"virtual-items-currency-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currency-package"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/items/virtual_items": {
"get": {
"summary": "Получение списка виртуальных предметов",
"description": "Получает список виртуальных предметов для построения каталога.\n\n\n Внимание
\n Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset.\n
\n\n
\n\n\n
Примечание\nБез авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить
персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Authorization. Подробная информация о JWT пользователя приведена в блоке
Безопасность для этого метода.
См. также: Метод Получение списка всех виртуальных предметов для поиска и индексирования на стороне клиента.",
"security": [
{
"XsollaLoginUserJWT": []
}
],
"operationId": "get-virtual-items",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/additional_fields-query-param"
},
{
"$ref": "#/components/parameters/country-query-param"
},
{
"$ref": "#/components/parameters/promo_code-query-param"
},
{
"$ref": "#/components/parameters/show_inactive_time_limited_items-query-param"
}
],
"tags": [
"virtual-items-currency-catalog"
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-get-items-list"
}
}
}
},
"/v2/project/{project_id}/items/virtual_items/sku/{item_sku}": {
"get": {
"summary": "Получение виртуального предмета по артикулу",
"description": "Получает виртуальный предмет по артикулу для построения каталога.\n\n\n
Внимание\nБез авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить
персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Authorization. Подробная информация о JWT пользователя приведена в блоке
Безопасность для этого метода.
\n Внимание
\n Возвращаются только артикул товара, название, группы и описание.\n
\n\n
\n\n\n
Примечание\nБез авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить
персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Authorization. Подробная информация о JWT пользователя приведена в блоке
Безопасность для этого метода.
См. также: Метод Получение списка всех виртуальных предметов для поиска и индексирования на стороне клиента.",
"security": [
{
"XsollaLoginUserJWT": []
}
],
"operationId": "get-all-virtual-items",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/promo_code-query-param"
}
],
"tags": [
"virtual-items-currency-catalog"
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-get-all-items-list"
}
}
}
},
"/v2/project/{project_id}/items/virtual_currency": {
"get": {
"summary": "Получение списка виртуальных валют",
"description": "Получает список виртуальных валют для построения каталога.\n\n\nВнимание
\nВсе проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset.\n
\n\n
\n\n\n
Примечание\nБез авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить
персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Authorization. Подробная информация о JWT пользователя приведена в блоке
Безопасность для этого метода.
\n
Примечание\nБез авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить
персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Authorization. Подробная информация о JWT пользователя приведена в блоке
Безопасность для этого метода.
\nВнимание
\nВсе проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset.\n
\n\n
\n\n\n
Примечание\nБез авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить
персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Authorization. Подробная информация о JWT пользователя приведена в блоке
Безопасность для этого метода.
\n
Примечание\nБез авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить
персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Authorization. Подробная информация о JWT пользователя приведена в блоке
Безопасность для этого метода.
\nВнимание
\nВсе проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset.\n
\n\n
\n\n\n
Примечание\nБез авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить
персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Authorization. Подробная информация о JWT пользователя приведена в блоке
Безопасность для этого метода.
\nВнимание
\nВсе проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset.\n
\n\n
\n\n\n
Примечание\nБез авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить
персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Authorization. Подробная информация о JWT пользователя приведена в блоке
Безопасность для этого метода.
\nВнимание
\nВсе проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset.\n
\n\n
\n\n\n
Примечание\nБез авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить
персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Authorization. Подробная информация о JWT пользователя приведена в блоке
Безопасность для этого метода.
NoteIn general, the use of catalog of items is available without authorization.
Only authorized users can get
a personalized catalog. ",
"operationId": "get-item-groups",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"security": [],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/with_geo-query-param"
}
],
"tags": [
"item-groups-catalog"
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-get-items-groups"
}
}
}
},
"/v2/project/{project_id}/admin/items/groups": {
"get": {
"summary": "Получение списка групп товаров",
"description": "Возвращает полный список групп товаров в рамках проекта без пагинации. Предназначен для административных задач.\n\n",
"operationId": "admin-get-item-group-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"item-groups-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/ItemGroup_200-admin-get-group-list"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
}
}
},
"post": {
"summary": "Создание группы товаров",
"description": "Создает группу товаров в проекте.\nЧтобы получить группы товаров для построения каталога, используйте клиентский метод Получение списка групп товаров.",
"operationId": "admin-create-item-group",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"item-groups-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/ItemGroup_create"
},
"responses": {
"201": {
"$ref": "#/components/responses/ItemGroup_201-admin-create-group"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-create-update"
}
}
}
},
"/v2/project/{project_id}/admin/items/groups/{external_id}": {
"get": {
"summary": "Получение группы товаров по внешнему ID ",
"description": "Возвращает группу товаров по ее внешнему ID для администрирования.\n\n",
"operationId": "admin-get-item-group",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/ItemGroup_200-admin-get-group"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-group-not-found"
}
}
},
"put": {
"summary": "Обновление группы товаров",
"description": "Обновляет группу товаров по внешнему ID.",
"operationId": "admin-update-item-group",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/ItemGroup_update"
},
"responses": {
"204": {
"$ref": "#/components/responses/ItemGroup_204-admin-update-group"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-group-not-found"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-create-update"
}
}
},
"delete": {
"summary": "Удаление группы товаров",
"description": "Удаляет группу товаров по внешнему ID.",
"operationId": "admin-delete-item-group",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"responses": {
"204": {
"$ref": "#/components/responses/ItemGroup_204-admin-delete-group"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-group-not-found"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-delete"
}
}
}
},
"/v2/project/{project_id}/admin/items/{item_type}/groups": {
"get": {
"summary": "Получение списка групп по типу товаров",
"description": "Возвращает список групп товаров с фильтрацией по типу товаров. Для групп подсчитывается только количество товаров, соответствующих заданному типу.Аналог метода [Получение списка групп товаров](/ru/api/catalog/item-groups-admin/admin-get-item-group-list) endpoint, with additional filtering of items by type when counting them.",
"operationId": "admin-get-item-group-list-by-item-type",
"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_type-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/ItemGroup_200-admin-get-group-list-by-item-type"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/{item_type}/groups/{external_id}": {
"get": {
"summary": "Получение группы товаров по внешнему ID с фильтрацией по типу товара",
"description": "Возвращает группу товаров по внешнему ID. Для группы подсчитывается только количество товаров, соответствующих заданному типу. Аналог метода [Получение списка групп товаров по внешнему ID](/ru/api/catalog/item-groups-admin/admin-get-item-group) с дополнительной фильтрацией товаров по типу при подсчете их количества.",
"operationId": "admin-get-item-group-by-item-type",
"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_type-group-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/ItemGroup_200-admin-get-group-by-item-type"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-group-not-found"
}
}
}
},
"/v2/project/{project_id}/admin/group/order": {
"put": {
"summary": "Изменение порядка групп товаров",
"description": "Задает порядок отображения групп товаров в рамках проекта. Передайте массив групп с новыми значениями порядка.",
"operationId": "admin-reorder-item-groups",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"item-groups-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/ItemGroup_order"
},
"responses": {
"204": {
"$ref": "#/components/responses/ItemGroup_204-admin-reorder-groups"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-reorder-groups-not-found"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-ordering"
}
}
}
},
"/v2/project/{project_id}/admin/group/{external_id}/order/item": {
"put": {
"summary": "Изменение порядка товаров в группе (по внешнему ID группы)",
"description": "Задает порядок отображения товаров в группе, определяемой ее внешним ID. Передайте массив товаров с новыми значениями порядка.",
"operationId": "admin-reorder-items-in-group",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/ItemGroup_item_order"
},
"responses": {
"204": {
"$ref": "#/components/responses/ItemGroup_204-admin-reorder-items"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-reorder-items-by-external-id-not-found"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-ordering"
}
}
}
},
"/v2/project/{project_id}/admin/group/id/{id}/order/item": {
"put": {
"summary": "Изменение порядка товаров в группе (по внутреннему ID группы)",
"description": "Задает порядок отображения товаров в группе, определяемой ее внутренним числовым ID. Передайте массив товаров с новыми значениями порядка.",
"operationId": "admin-reorder-items-in-group-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/ItemGroup_item_order"
},
"responses": {
"204": {
"$ref": "#/components/responses/ItemGroup_204-admin-reorder-items"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-reorder-items-by-id-not-found"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-ordering"
}
}
}
},
"/v2/project/{project_id}/payment/item/{item_sku}/virtual/{virtual_currency_sku}": {
"post": {
"summary": "Создание заказа с указанным товаром, приобретенным за виртуальную валюту",
"description": "Создает покупку товара с использованием виртуальной валюты.
\n\n\n
Примечание\nБез авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить
персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Authorization. Подробная информация о JWT пользователя приведена в блоке
Безопасность для этого метода.
\nВнимание
\nВсе проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset.\n
\n\n
\n\n\n
Примечание\nБез авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить
персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Authorization. Подробная информация о JWT пользователя приведена в блоке
Безопасность для этого метода.
\nВнимание
\nВсе проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset.\n
\n\n
\n\n\n
Примечание\nБез авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить
персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Authorization. Подробная информация о JWT пользователя приведена в блоке
Безопасность для этого метода.
\n
Примечание\nБез авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить
персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Authorization. Подробная информация о JWT пользователя приведена в блоке
Безопасность для этого метода.
\n
Примечание\nБез авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить
персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Authorization. Подробная информация о JWT пользователя приведена в блоке
Безопасность для этого метода.
\nВнимание
\nВсе проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset.\n
\n\n
\n\n\n
Примечание\nБез авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить
персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Authorization. Подробная информация о JWT пользователя приведена в блоке
Безопасность для этого метода.
Примечание
Не используйте данный метод для построения каталога магазина.
",
"operationId": "admin-get-game-list",
"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/promo_code-query-param"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-admin-get-games-list"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/game/sku/{item_sku}": {
"get": {
"summary": "Получение игры (admin)",
"description": "Получает игру для администрирования.\nИгра состоит из игровых ключей, которые могут быть приобретены пользователем.\n\nПримечание
Не используйте данный метод для построения каталога магазина.
",
"operationId": "admin-get-game-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
},
{
"$ref": "#/components/parameters/promo_code-query-param"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-admin-get-game-by-sku"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Игра не найдена.",
"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 = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
},
"put": {
"summary": "Обновление игры по артикулу",
"description": "Обновляет игру в проекте по артикулу.",
"operationId": "admin-update-game-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Game-Keys_create-update-game-model"
},
"responses": {
"201": {
"description": "Игра обновлена успешно."
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Игра не найдена.",
"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 = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
},
"422": {
"$ref": "#/components/responses/Game-Keys_422-invalid-request"
}
}
},
"delete": {
"summary": "Удаление игры по артикулу",
"description": "Удаляет игру в проекте по артикулу.",
"operationId": "admin-delete-game-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"204": {
"description": "Игра удалена успешно."
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/game/id/{item_id}": {
"get": {
"summary": "Получение игры по ID (admin)",
"description": "Получает игру для администрирования.\nИгра состоит из игровых ключей, которые могут быть приобретены пользователем.\n\nПримечание
Не используйте данный метод для построения каталога магазина.
",
"operationId": "admin-get-game-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
},
{
"$ref": "#/components/parameters/promo_code-query-param"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-admin-get-game-by-sku"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Игра не найдена.",
"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 id = 1 not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with id = 1 not found"
}
}
}
}
}
}
}
},
"put": {
"summary": "Обновление игры по ID",
"description": "Обновляет игру в проекте по ID.",
"operationId": "admin-update-game-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Game-Keys_create-update-game-model"
},
"responses": {
"201": {
"description": "Игра обновлена успешно."
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Игра не найдена.",
"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 id = 1 not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with id = 1 not found"
}
}
}
}
}
},
"422": {
"$ref": "#/components/responses/Game-Keys_422-invalid-request"
}
}
},
"delete": {
"summary": "Удаление игры по ID",
"description": "Удаляет игру в проекте по ID.",
"operationId": "admin-delete-game-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"204": {
"description": "Игра удалена успешно."
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/upload/sku/{item_sku}": {
"post": {
"summary": "Загрузка кодов",
"description": "Загружает коды по артикулу игрового ключа.",
"operationId": "admin-upload-codes-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "File with codes."
},
"region_id": {
"type": "integer",
"description": "ID региона."
}
},
"required": [
"file"
],
"example": {
"file": "keys.txt",
"region_id": 1
}
}
}
},
"required": true
},
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-session-information"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Игровой ключ или регион не найдены.",
"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 = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/upload/id/{item_id}": {
"post": {
"summary": "Загрузка кодов по ID",
"description": "Загружает коды по ID игрового ключа.",
"operationId": "admin-upload-codes-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "File with codes."
},
"region_id": {
"type": "integer",
"description": "ID региона."
}
},
"required": [
"file"
],
"example": {
"file": "keys.txt",
"region_id": 1
}
}
}
}
},
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-session-information"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Игровой ключ или регион не найдены.",
"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 = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/upload/session/{session_id}": {
"get": {
"summary": "Получение информации о сеансе загрузки кодов",
"description": "Получает информацию о сеансе загрузки кодов.",
"operationId": "admin-get-codes-session",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"name": "session_id",
"in": "path",
"required": true,
"description": "ID сеанса.",
"schema": {
"type": "string",
"default": "fc7105b6e8ee01339582970b37697242"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-session-information"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Сеанс загрузки кодов не найден."
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/request/sku/{item_sku}": {
"get": {
"summary": "Получение кодов",
"description": "Получает определенное количество кодов по артикулу игрового ключа.",
"operationId": "admin-get-codes-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
},
{
"$ref": "#/components/parameters/user_email-query-param"
},
{
"$ref": "#/components/parameters/quantity-query-param"
},
{
"$ref": "#/components/parameters/reason-query-param"
},
{
"$ref": "#/components/parameters/region_id-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-get-codes"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Игровой ключ или регион не найдены.",
"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 = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/request/id/{item_id}": {
"get": {
"summary": "Получение кодов по ID",
"description": "Получает определенное количество кодов по ID игрового ключа.",
"operationId": "admin-get-codes-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
},
{
"$ref": "#/components/parameters/user_email-query-param"
},
{
"$ref": "#/components/parameters/quantity-query-param"
},
{
"$ref": "#/components/parameters/reason-query-param"
},
{
"$ref": "#/components/parameters/region_id-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-get-codes"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Игровой ключ или регион не найдены.",
"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 = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/delete/sku/{item_sku}": {
"delete": {
"summary": "Удаление кодов",
"description": "Удаляет все коды по артикулу игрового ключа.",
"operationId": "admin-delete-codes-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
},
{
"$ref": "#/components/parameters/user_email-query-param"
},
{
"$ref": "#/components/parameters/reason-query-param"
},
{
"$ref": "#/components/parameters/region_id-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-get-codes"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Игровой ключ или регион не найдены.",
"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 = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/delete/id/{item_id}": {
"delete": {
"summary": "Удаление кодов по ID",
"description": "Удаляет все коды по ID игрового ключа.",
"operationId": "admin-delete-codes-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
},
{
"$ref": "#/components/parameters/user_email-query-param"
},
{
"$ref": "#/components/parameters/reason-query-param"
},
{
"$ref": "#/components/parameters/region_id-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-get-codes"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Игровой ключ или регион не найдены.",
"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 = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/entitlement": {
"get": {
"tags": [
"game-keys-entitlement"
],
"operationId": "get-user-games",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/sandbox-query-param"
},
{
"$ref": "#/components/parameters/additional_fields-entitlement-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-user-entitlement-list"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
}
},
"summary": "Получение списка игр, принадлежащих пользователю",
"description": "Получает список игр, принадлежащих пользователю. Ответ будет содержать массив игр, принадлежащих определенному пользователю.\n\n\nВнимание
\nВсе проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset.\n
\n\n
\n\n\n
Примечание\nБез авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить
персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Authorization. Подробная информация о JWT пользователя приведена в блоке
Безопасность для этого метода.
\n Обратите внимание
\n Вы можете активировать коды только для платформы без DRM.\n
\n\n
\n\n\n
Примечание\nБез авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить
персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Authorization. Подробная информация о JWT пользователя приведена в блоке
Безопасность для этого метода.
Внимание
Могут быть предоставлены только игровые ключи или игры для DRM-free-платформ.
",
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user_external_id",
"game",
"drm",
"mode"
],
"properties": {
"user_external_id": {
"type": "string",
"example": "user-external-id",
"description": "Unique user identifier."
},
"game": {
"type": "object",
"required": [
"sku"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Game-Keys_game_sku"
}
},
"example": {
"game": {
"sku": "com.xsolla.game_1"
}
},
"description": "Object with game properties."
},
"drm": {
"type": "object",
"required": [
"sku"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Game-Keys_drm_sku"
}
},
"example": {
"drm": {
"sku": "com.xsolla.key_1"
}
},
"description": "Object with DRM properties."
},
"code": {
"type": [
"string",
"null"
],
"example": "AAAA-BBBB-CCCC-DDDD",
"description": "Game code of the game."
},
"mode": {
"type": "string",
"enum": [
"default",
"sandbox"
],
"example": "default",
"description": "What type of entitlements should be granted. If the parameter is set to `sandbox`, the entitlement will be granted to the user in the sandbox mode. If the parameter is set to `default`, the entitlement will be granted to the user in the live mode."
},
"user_country": {
"type": [
"string",
"null"
],
"example": "US",
"description": "User's country."
}
},
"example": {
"user_external_id": "user-external-id",
"game": {
"sku": "com.xsolla.game_1"
},
"drm": {
"sku": "com.xsolla.key_1"
},
"code": "AAAA-BBBB-CCCC-DDDD",
"mode": "default",
"user_country": "US"
}
}
}
},
"required": true
}
}
},
"/v2/project/{project_id}/admin/entitlement/revoke": {
"post": {
"tags": [
"game-keys-entitlement"
],
"operationId": "revoke-entitlement-admin",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"responses": {
"204": {
"description": "Отозвано успешно."
},
"403": {
"$ref": "#/components/responses/Game-Keys_403-auth-header-not-sent"
},
"422": {
"description": "Неверный запрос.",
"content": {
"application/json": {
"schema": {
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 5103
},
"errorMessage": {
"type": "string",
"example": "[0401-5103]: Selected drm is not drmfree."
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"type": "object"
},
"examples": {
"DRM is not DRM free": {
"value": {
"statusCode": 422,
"errorCode": 5103,
"errorMessage": "[0401-5103]: Selected drm is not drmfree.",
"transactionId": "transaction id"
}
}
}
}
}
}
},
"summary": "Отзыв права владения (admin)",
"description": "Отзывает право владения у пользователя.\n\nВнимание
Могут быть отозваны только игровые ключи или игры для DRM-free-платформ.
",
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user_external_id",
"game",
"drm",
"mode"
],
"properties": {
"user_external_id": {
"type": "string",
"example": "user-external-id",
"description": "Unique user identifier."
},
"game": {
"type": "object",
"required": [
"sku"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Game-Keys_game_sku"
}
},
"example": {
"game": {
"sku": "com.xsolla.game_1"
}
},
"description": "Object with game properties."
},
"drm": {
"type": "object",
"required": [
"sku"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Game-Keys_drm_sku"
}
},
"example": {
"drm": {
"sku": "com.xsolla.key_1"
}
},
"description": "Object with DRM properties."
},
"mode": {
"type": "string",
"enum": [
"default",
"sandbox"
],
"example": "default",
"description": "What type of entitlements should be revoked. If the parameter is set to `sandbox`, the entitlement will be revoked from the user in the sandbox mode. If the parameter is set to `default`, the entitlement will be revoked from the user in the live mode."
}
},
"example": {
"user_external_id": "user-external-id",
"game": {
"sku": "com.xsolla.game_1"
},
"drm": {
"sku": "com.xsolla.key_1"
},
"mode": "default"
}
}
}
},
"required": true
}
}
},
"/v2/project/{project_id}/admin/items/bundle": {
"get": {
"summary": "Получение списка бандлов",
"description": "Получает список бандлов в рамках проекта для администрирования.\n\nПримечание
Не используйте данный метод для построения каталога магазина.
",
"operationId": "admin-get-bundle-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Bundles_200-admin-get-bundle-list"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
},
"post": {
"summary": "Создание бандла",
"description": "Создает бандл — набор товаров, который продается как единое целое. В состав бандла можно добавить виртуальные предметы, пакеты виртуальной валюты, игровые ключи и другие бандлы. Подробная информация о работе с бандлами приведена в разделе [Бандлы](https://developers.xsolla.com/ru/items-catalog/items-type/bundles/).\n\nВнимание
. Все товары, перечисленные в массиве content, должны быть созданы в вашем проекте заранее. Если указанный артикул не существует, система вернет ошибку.
",
"security": [
{
"basicAuth": []
}
],
"operationId": "admin-create-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"bundles-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Bundles_bundle"
},
"responses": {
"201": {
"$ref": "#/components/responses/Bundles_201-admin-create-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Bundles_422-invalid-request"
}
}
}
},
"/v2/project/{project_id}/admin/items/bundle/group/id/{group_id}": {
"get": {
"summary": "Получение списка бандлов по указанному ID группы",
"description": "Получает список бандлов в рамках группы для администрирования.\n\nПримечание
Не используйте данный метод для построения каталога магазина.
",
"operationId": "admin-get-bundle-list-in-group-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/group_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Bundles_200-admin-get-bundle-list-in-group"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/bundle/group/external_id/{external_id}": {
"get": {
"summary": "Получение списка бандлов по указанному External ID группы",
"description": "Получает список бандлов в рамках группы для администрирования.\n\nПримечание
Не используйте данный метод для построения каталога магазина.
",
"operationId": "admin-get-bundle-list-in-group-by-external-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Bundles_200-admin-get-bundle-list-in-group"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/bundle/sku/{sku}": {
"put": {
"summary": "Обновление бандла",
"description": "Обновляет бандл. Метод полностью заменяет бандл — передайте все обязательные поля в теле запроса, а не только те, которые необходимо изменить. Подробная информация о работе с бандлами приведена в разделе [Бандлы](https://developers.xsolla.com/ru/items-catalog/items-type/bundles/).\n\nВнимание
. Все товары, перечисленные в массиве content, должны быть созданы в вашем проекте заранее. Если указанный артикул не существует, система вернет ошибку.
",
"operationId": "admin-update-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/sku-path-param"
}
],
"tags": [
"bundles-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Bundles_bundle"
},
"responses": {
"204": {
"$ref": "#/components/responses/Bundles_204-admin-update-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Bundles_422-invalid-request"
}
}
},
"delete": {
"summary": "Удаление бандла",
"description": "Удаляет бандл.",
"operationId": "admin-delete-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/sku-path-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"204": {
"$ref": "#/components/responses/Bundles_204-admin-delete-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
},
"get": {
"summary": "Получение бандла",
"description": "Получает бандл в рамках проекта для администрирования.\n\nПримечание
Не используйте данный метод для построения каталога магазина.
",
"operationId": "admin-get-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/sku-path-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Bundles_200-admin-get-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/bundle/sku/{sku}/show": {
"put": {
"summary": "Отображение бандла в каталоге",
"description": "Показывает бандл в каталоге.",
"operationId": "admin-show-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/sku-path-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"204": {
"$ref": "#/components/responses/Bundles_204-admin-show-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/bundle/sku/{sku}/hide": {
"put": {
"summary": "Скрытие бандла в каталоге",
"description": "Скрывает бандл в каталоге.",
"operationId": "admin-hide-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/sku-path-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"204": {
"$ref": "#/components/responses/Bundles_204-admin-hide-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/items/bundle": {
"get": {
"summary": "Получение списка бандлов",
"description": "Получает список бандлов для построения каталога.\n\n\nВнимание
\nВсе проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset.\n
\n\n
\n\n\n
Примечание\nБез авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить
персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Authorization. Подробная информация о JWT пользователя приведена в блоке
Безопасность для этого метода.
\n
Примечание\nБез авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить
персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Authorization. Подробная информация о JWT пользователя приведена в блоке
Безопасность для этого метода.
\nВнимание
\nВсе проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset.\n
\n\n
\n\n\n
Примечание\nБез авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить
персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Authorization. Подробная информация о JWT пользователя приведена в блоке
Безопасность для этого метода.
Внимание Поскольку этот метод использует IP-адрес для определения страны пользователя и валюты для заказа, важно использовать этот метод только на стороне клиента, а не на стороне сервера. Использование этого метода на стороне сервера может привести к неправильному определению валюты и повлиять на способы оплаты в
Pay Station.
",
"operationId": "create-order-by-cart-id",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/cart_id-path-param"
}
],
"tags": [
"payment-client-side"
],
"security": [
{
"AuthForCart": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_create-order-by-cart-idJsonModel"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Payment_200-order-created"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/project/{project_id}/payment/cart": {
"post": {
"summary": "Создание заказа со всеми товарами из текущей корзины",
"description": "Используется для интеграции клиент-сервер. Создает заказ со всеми товарами из корзины и генерирует для него токен оплаты. Созданный заказ получает `new` статус заказа.\n\nIP-адрес клиента используется для определения страны пользователя, которая затем используется для применения соответствующей валюты и доступных способов оплаты заказа.\n\nЧтобы открыть платежный интерфейс в новом окне, воспользуйтесь следующей ссылкой: `https://secure.xsolla.com/paystation4/?token={token}`, где `{token}` — полученный токен.\n\nДля целей тестирования используйте этот URL-адрес: `https://sandbox-secure.xsolla.com/paystation4/?token={token}`.\n\nВнимание Поскольку этот метод использует IP-адрес для определения страны пользователя и валюты для заказа, важно использовать этот метод только на стороне клиента, а не на стороне сервера. Использование этого метода на стороне сервера может привести к неправильному определению валюты и повлиять на способы оплаты в
Pay Station.
",
"operationId": "create-order",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"payment-client-side"
],
"security": [
{
"AuthForCart": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_create-order-by-cart-idJsonModel"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Payment_200-order-created"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/project/{project_id}/payment/item/{item_sku}": {
"post": {
"summary": "Создание заказа с указанным товаром",
"description": "Используется для интеграции клиент-сервер. Создает заказ с указанным товаром и генерирует для него токен оплаты. Созданный заказ получает статус заказа `new`.\n\nIP-адрес клиента используется для определения страны пользователя, которая затем используется для применения соответствующей валюты и доступных способов оплаты заказа.\n\nЧтобы открыть платежный интерфейс в новом окне, воспользуйтесь следующей ссылкой: `https://secure.xsolla.com/paystation4/?token={token}`, где `{token}` — полученный токен.\n\nДля целей тестирования используйте этот URL-адрес: `https://sandbox-secure.xsolla.com/paystation4/?token={token}`.\n\nВнимание Поскольку этот метод использует IP-адрес для определения страны пользователя и валюты для заказа, важно использовать этот метод только на стороне клиента, а не на стороне сервера. Использование этого метода на стороне сервера может привести к неправильному определению валюты и повлиять на способы оплаты в
Pay Station.
\n\n
\n\n\n Уведомление
\n Этот метод использует JWT пользователя для авторизации.
\n Передайте токен в заголовке Authorization в формате Bearer <user_JWT>. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода.\n
",
"operationId": "create-order-with-item",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"payment-client-side"
],
"security": [
{
"XsollaLoginUserJWT": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_create-order-with-specified-item-idJsonModel"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Payment_200-order-created"
},
"404": {
"$ref": "#/components/responses/Cart-Payment_404-create-order-with-item-not-found-errors"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-create-order-with-item-invalid"
}
}
}
},
"/v2/project/{project_id}/free/cart": {
"post": {
"summary": "Создание заказа с помощью бесплатной корзины",
"description": "Создает заказ со всеми товарами из бесплатной корзины. Созданному заказу будет присвоен статус заказа `done`.",
"operationId": "create-free-order",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"free-item"
],
"security": [
{
"AuthForCart": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_create-order-by-cart-idJsonModel"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Free_200-order-created"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/project/{project_id}/free/cart/{cart_id}": {
"post": {
"summary": "Создание заказа с помощью определенной бесплатной корзины",
"description": "Создает заказ со всеми товарами из определенной бесплатной корзины. Созданному заказу будет присвоен статус заказа `done`.",
"operationId": "create-free-order-by-cart-id",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/cart_id-path-param"
}
],
"tags": [
"free-item"
],
"security": [
{
"AuthForCart": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_create-order-by-cart-idJsonModel"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Free_200-order-created"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/project/{project_id}/free/item/{item_sku}": {
"post": {
"summary": "Создание заказа с указанным бесплатным товаром",
"description": "Создает заказ с указанным бесплатным товаром. Созданному заказу будет присвоен статус заказа `done`.
\n\n\n
Примечание\nБез авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить
персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Authorization. Подробная информация о JWT пользователя приведена в блоке
Безопасность для этого метода.
Внимание\n
\n Для корректной работы метода требуется передать либо параметр
user.country.value (код страны), либо заголовок
X-User-Ip (
IPv4-адрес пользователя, если страна неизвестна). Переданные данные используются для определения валюты оплаты в Xsolla.
IPv6-адреса не поддерживаются.
Выбранная валюта используется для оплаты в
платежном интерфейсе Xsolla.\n
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"payment-server-side"
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_admin-create-payment-token"
},
"responses": {
"201": {
"$ref": "#/components/responses/Cart-Payment_201-admin-create-payment-token"
},
"401": {
"$ref": "#/components/responses/Cart-Payment_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-admin-create-payment-token"
}
}
}
},
"/v2/admin/project/{project_id}/cart/fill": {
"put": {
"summary": "Наполнение корзины товарами",
"description": "Заполняет текущую корзину товарами. Если в корзине уже есть товар с таким же артикулом, существующий товар будет заменен на переданное значение.",
"operationId": "admin-cart-fill",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/x-user-for-header"
},
{
"$ref": "#/components/parameters/x-user-id-header"
}
],
"tags": [
"cart-server-side"
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_admin-fill-cart-json-model"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Payment_200-admin-fill-cart-json-model"
},
"401": {
"$ref": "#/components/responses/Cart-Payment_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Cart-Payment_404-user"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/admin/project/{project_id}/cart/{cart_id}/fill": {
"put": {
"summary": "Наполнение корзины по ID корзины товарами",
"description": "Заполняет корзину товарами по идентификатору корзины. Если в корзине уже есть товар с таким же артикулом, существующий товар будет заменен на переданное значение.",
"operationId": "admin-fill-cart-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/cart_id-path-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/x-user-for-header"
},
{
"$ref": "#/components/parameters/x-user-id-header"
}
],
"tags": [
"cart-server-side"
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_admin-fill-cart-json-model"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Payment_200-admin-fill-cart-json-model"
},
"401": {
"$ref": "#/components/responses/Cart-Payment_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Cart-Payment_404-user"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/project/{project_id}/admin/user/limit/item/all": {
"delete": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "reset-all-user-items-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/operation/admin-create-game/)\n* [Виртуальные предметы и валюта](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Бандлы](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-get-bundle-list/)",
"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": {
"value": {
"statusCode": 404,
"errorCode": 5008,
"errorMessage": "[0401-5008]: Could not find User"
}
}
}
}
}
},
"422": {
"description": "Неверный запрос.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array",
"items": {
"type": "object",
"properties": {
"property": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"value": {
"statusCode": 404,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity",
"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+$"
}
]
}
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/reset-user-limits"
}
}
},
"/v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}/all": {
"delete": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "reset-user-item-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Обновление лимита на покупку",
"description": "Обновляет лимит на покупку товара, чтобы пользователь мог купить его снова. Если параметр *user* равен `null`, этот метод обновляет лимит для всех пользователей.\n\nAPI лимитов на покупку позволяет вам продавать товар в ограниченном количестве. Чтобы настроить лимиты покупок, перейдите в раздел Admin нужного типа товара:\n* [Игровые ключи](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-create-game/)\n* [Виртуальные предметы и валюта](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Бандлы](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-get-bundle-list/)",
"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-item-by-sku-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"
},
"Item does not have configured user limits": {
"$ref": "#/components/examples/422-item-without-user-limit"
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/reset-user-limits-flexible"
}
}
},
"/v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}": {
"get": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "get-user-item-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
},
{
"$ref": "#/components/parameters/user_external_id-query-param"
}
],
"summary": "Получение лимита доступных пользователю товаров",
"description": "Возвращает оставшееся количество товаров, доступных указанному пользователю, в пределах установленного лимита.\n\nAPI лимитов на покупку позволяет вам продавать товар в ограниченном количестве. Чтобы настроить лимиты покупок, перейдите в раздел Admin нужного типа товара:\n* [Игровые ключи](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-create-game/)\n* [Виртуальные предметы и валюта](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Бандлы](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-get-bundle-list/)",
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-item-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-item-by-sku-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"
},
"Item does not have configured user limits": {
"$ref": "#/components/examples/422-item-without-user-limit"
}
}
}
}
}
}
},
"post": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "add-user-item-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Увеличение лимита доступных пользователю товаров",
"description": "Увеличивает оставшееся количество товаров, доступных указанному пользователю, в пределах установленного ограничения.\n\nAPI лимитов на покупку позволяет вам продавать товар в ограниченном количестве. Чтобы настроить лимиты покупок, перейдите в раздел Admin нужного типа товара:\n* [Игровые ключи](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-create-game/)\n* [Виртуальные предметы и валюта](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Бандлы](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-get-bundle-list/)",
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-item-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-item-by-sku-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"
},
"Item does not have configured user limits": {
"$ref": "#/components/examples/422-item-without-user-limit"
},
"Available item limit is out of range": {
"$ref": "#/components/examples/422-item-out-of-range-available-user-limit"
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/update-user-limits-strict"
}
},
"put": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "set-user-item-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Настройка лимита доступных пользователю товаров",
"description": "Устанавливает количество товаров, которые указанный пользователь может купить в пределах ограничения, примененного после его увеличения или уменьшения.\n\nAPI лимитов на покупку позволяет вам продавать товар в ограниченном количестве. Чтобы настроить лимиты покупок, перейдите в раздел Admin нужного типа товара:\n* [Игровые ключи](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-create-game/)\n* [Виртуальные предметы и валюта](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Бандлы](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-get-bundle-list/)",
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-item-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-item-by-sku-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"
},
"Item does not have configured user limits": {
"$ref": "#/components/examples/422-item-without-user-limit"
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/update-user-limits-flexible"
}
},
"delete": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "remove-user-item-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Уменьшение лимита доступных пользователю товаров",
"description": "Уменьшает оставшееся количество товаров, доступных указанному пользователю в пределах установленного лимита.\n\nAPI лимитов на покупку позволяет вам продавать товар в ограниченном количестве. Чтобы настроить лимиты покупок, перейдите в раздел Admin нужного типа товара:\n* [Игровые ключи](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-create-game/)\n* [Виртуальные предметы и валюта](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Бандлы](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-get-bundle-list/)",
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-item-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-item-by-sku-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"
},
"Item does not have configured user limits": {
"$ref": "#/components/examples/422-item-without-user-limit"
},
"Available item limit is out of range": {
"$ref": "#/components/examples/422-item-out-of-range-available-user-limit"
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/update-user-limits-strict"
}
}
},
"/v1/projects/{project_id}/import/from_external_file": {
"post": {
"tags": [
"connector-admin"
],
"operationId": "import-items-from-external-file",
"summary": "Импорт товаров из JSON-файла",
"description": "Импортирует товары в магазин из JSON-файла по указанному URL-адресу. Подробная информация об импорте из JSON-файла приведена в [документации](https://developers.xsolla.com/ru/doc/shop-builder/how-to/json-import/).",
"servers": [
{
"url": "https://connector.xsolla.com"
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"responses": {
"201": {
"description": "Файл был успешно импортирован и находится в обработке.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"import_id": {
"type": "string",
"example": "af9f3638a16e11ef880da2cd677d2d24",
"description": "Import operation ID. If you encounter difficulties importing the JSON file, report this ID to your Customer Success Manager or send an email to csm@xsolla.com."
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/connector-422-validation-failed"
}
},
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/connector-import-items-body"
}
}
},
"/v1/admin/projects/{project_id}/connectors/import_items/import/status": {
"get": {
"tags": [
"connector-admin"
],
"operationId": "get-items-import-status",
"summary": "Получение статуса импорта товаров",
"description": "Возвращает информацию о прогрессе импорта товаров в проект. Метод возвращает данные по последнему импорту, выполненному через API или Личный кабинет.",
"servers": [
{
"url": "https://connector.xsolla.com"
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-items-import-status-model"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
]
}
},
"/v2/project/{project_id}/admin/webhook/version": {
"put": {
"tags": [
"common-webhooks"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "update-webhook-version",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"summary": "Обновление версии вебхука",
"description": "Обновляет версию вебхуков в проекте. Для версии 2 в массиве `items` появляются дополнительные параметры.\n\nПодробная информация о настройке вебхуков доступна в разделе [Отслеживание статуса заказа](https://developers.xsolla.com/ru/doc/shop-builder/integration-guide/set-up-webhooks/).",
"responses": {
"204": {
"description": "Версия вебхука обновлена успешно."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"422": {
"description": "Ошибка валидации запроса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/422-invalid-request-extended"
},
"examples": {
"response": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity",
"errorMessageExtended": [
{
"property": "version",
"message": "Must have a minimum value of 1"
}
],
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
}
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"version": {
"type": "integer",
"description": "Webhook version. Version 1 is used by default. In version 2, the `items` array includes the following parameters: `is_free`, `is_bonus`, and `is_bundle_content` parameters.",
"enum": [
1,
2
],
"example": 2
}
},
"required": [
"version"
]
},
"example": {
"version": 2
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}": {
"get": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "get-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Получение информации о лимите предзаказа товара",
"description": "Возвращает ограничение на предзаказ товара.\n\nPre-Order limit API позволяет продавать товар в ограниченном количестве. Для настройки самого предзаказа перейдите в раздел Admin желаемого товара:\n* [Игровые ключи](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-create-game/)\n* [Виртуальные предметы и валюта](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Бандлы](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-get-bundle-list/)\n\nАлиасы для данного эндпоинта:\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}",
"responses": {
"200": {
"description": "Информация о лимите предзаказа товара получена успешно.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"example": 1
},
"sku": {
"type": "string",
"example": "com.xsolla.item_1"
},
"is_pre_order_limit_enabled": {
"type": "boolean",
"example": true
},
"available": {
"type": "integer",
"example": 431
},
"reserved": {
"type": "integer",
"example": 13
},
"sold": {
"type": "integer",
"example": 556
}
}
},
"examples": {
"response": {
"value": {
"item_id": 1,
"sku": "com.xsolla.item_1",
"is_pre_order_limit_enabled": true,
"available": 431,
"reserved": 13,
"sold": 556
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Товар не найден."
}
}
},
"post": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "add-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Увеличение лимита предзаказа товара",
"description": "Добавляет количество к ограничению на предзаказ товара.\n\nPre-Order limit API позволяет продавать товар в ограниченном количестве. Для настройки самого предзаказа перейдите в раздел Admin желаемого товара:\n* [Игровые ключи](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-create-game/)\n* [Виртуальные предметы и валюта](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Бандлы](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-get-bundle-list/)\n\nАлиасы для данного эндпоинта:\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}",
"responses": {
"201": {
"description": "Указанное количество успешно добавлено к лимиту предзаказа."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Товар не найден."
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"quantity": {
"type": "integer",
"description": "Quantity to add."
}
},
"required": [
"quantity"
]
},
"example": {
"quantity": 100000
}
}
}
}
},
"put": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "set-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Установка/обновление лимита предзаказа товара",
"description": "Устанавливает ограничение на количество товара для предварительного заказа.\n\nPre-Order limit API позволяет продавать товар в ограниченном количестве. Для настройки самого предзаказа перейдите в раздел Admin желаемого товара:\n* [Игровые ключи](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-create-game/)\n* [Виртуальные предметы и валюта](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Бандлы](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-get-bundle-list/)\n\nАлиасы для данного эндпоинта:\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}",
"responses": {
"204": {
"description": "Количество для лимита предзаказа установлено успешно."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Товар не найден."
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"quantity": {
"type": "integer",
"description": "Quantity to set."
}
},
"required": [
"quantity"
]
},
"example": {
"quantity": 100000
}
}
}
}
},
"delete": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "remove-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Уменьшение лимита предзаказа товара",
"description": "Удаляет ограничение на количество предзаказа товара.\n\nPre-Order limit API позволяет продавать товар в ограниченном количестве. Для настройки самого предзаказа перейдите в раздел Admin желаемого товара:\n* [Игровые ключи](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-create-game/)\n* [Виртуальные предметы и валюта](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Бандлы](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-get-bundle-list/)\n\nАлиасы для данного эндпоинта:\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}",
"responses": {
"204": {
"description": "Указанное количество успешно удалено из лимита предзаказа."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Товар не найден."
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"quantity": {
"type": "integer",
"description": "Quantity to remove."
}
},
"required": [
"quantity"
]
},
"example": {
"quantity": 100000
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/toggle": {
"put": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "toggle-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Включение/отключение лимита предзаказа товара",
"description": "Включает/отключает лимит предзаказа товара.\n\nPre-Order limit API позволяет вам продавать товар в ограниченном количестве. Для настройки самого предварительного заказа перейдите в раздел администратора модуля нужного товара:\n* [Игровые ключи](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-create-game/)\n* [Виртуальные предметы и валюта](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Бандлы](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-get-bundle-list/)\n\nАлиасы для данного метода:\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}/toggle",
"responses": {
"204": {
"description": "Лимит отключен/включен."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Товар не найден."
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"is_pre_order_limit_enabled": {
"type": "boolean"
}
},
"required": [
"is_pre_order_limit_enabled"
]
},
"example": {
"is_pre_order_limit_enabled": true
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/all": {
"delete": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "remove-all-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Обнуление лимита предзаказа товара",
"description": "Удаляет все ограничения по количеству товара, предусмотренные для предварительного заказа.\n\nPre-Order limit API позволяет вам продавать товар в ограниченном количестве. Для настройки самого предварительного заказа перейдите в раздел администратора модуля нужного товара:\n* [Игровые ключи](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-create-game/)\n* [Виртуальные предметы и валюта](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Бандлы](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-get-bundle-list/)\n\nAliases для этой конечной точки:\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}/all",
"responses": {
"204": {
"description": "Лимит успешно удален."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Товар не найден."
}
}
}
},
"/v2/merchant/{merchant_id}/projects": {
"get": {
"tags": [
"common-merchant"
],
"operationId": "get-projects",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicMerchantAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/merchant_id-path-param"
}
],
"summary": "Получение проектов",
"description": "Получает список проектов мерчанта.\n\n\n
Внимание
Этот метод API не включает в себя path-параметр project_id, поэтому для авторизации вам необходимо использовать ключ API, который действует во всех проектах.
\n
\nВнимание
\nВсе проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset.\n
\n\n
\n\n\n
Примечание\nБез авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить
персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Authorization. Подробная информация о JWT пользователя приведена в блоке
Безопасность для этого метода.
\n
Примечание\nБез авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить
персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Authorization. Подробная информация о JWT пользователя приведена в блоке
Безопасность для этого метода.
\n
Примечание\nБез авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить
персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Authorization. Подробная информация о JWT пользователя приведена в блоке
Безопасность для этого метода.
\nВнимание
\nВсе проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset.\n
\n\n
\n\n\n
Примечание\nБез авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить
персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Authorization. Подробная информация о JWT пользователя приведена в блоке
Безопасность для этого метода.
Внимание
Если вы удалите атрибут товара, все его данные и связи с товарами будут удалены.
",
"operationId": "delete-attribute",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-attr-path-param"
}
],
"tags": [
"attribute-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"204": {
"description": "Атрибут удален успешно."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/attribute/{external_id}/value": {
"post": {
"summary": "Создание значения атрибута",
"description": "Создает значение атрибута.\n\nВнимание
Все проекты имеют ограничение на количество значений атрибута. Значение по умолчанию и максимальное значение — 20 значений для каждого атрибута.
",
"operationId": "admin-create-attribute-value",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-attr-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-update-attribute-value"
},
"tags": [
"attribute-admin"
],
"responses": {
"201": {
"$ref": "#/components/responses/201-admin-create-attribute-value"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
},
"404": {
"$ref": "#/components/responses/404-attribute-not-found"
},
"422": {
"$ref": "#/components/responses/422-create-update-attribute-value"
}
}
},
"delete": {
"summary": "Удаление всех значений атрибута",
"description": "Удаляет все значения атрибута.\n\nВниманиеЕсли вы удалите значение атрибута, связь атрибута с товарами будет потеряна. Чтобы изменить значение атрибута для товара, используйте метод
Обновление значения атрибута вместо удаления значения и создания нового.
",
"operationId": "admin-delete-all-attribute-value",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-attr-path-param"
}
],
"tags": [
"attribute-admin"
],
"responses": {
"204": {
"description": "Значения атрибутов удалены успешно."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
}
}
}
},
"/v2/project/{project_id}/admin/attribute/{external_id}/value/{value_external_id}": {
"put": {
"summary": "Обновление значения атрибута",
"description": "Обновляет значения атрибута.",
"operationId": "admin-update-attribute-value",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/value_external_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-attr-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-update-attribute-value"
},
"tags": [
"attribute-admin"
],
"responses": {
"204": {
"description": "Значение атрибута обновлено успешно."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
},
"404": {
"$ref": "#/components/responses/404-attribute-value-not-found"
},
"422": {
"$ref": "#/components/responses/422-create-update-attribute-value"
}
}
},
"delete": {
"summary": "Удаление значения атрибута",
"description": "Удаляет значение атрибута.\n\nВниманиеЕсли вы удалите значение атрибута, связь атрибута с товарами будет потеряна. Чтобы изменить значение атрибута для товара, используйте метод
Обновление значения атрибута вместо удаления значения и создания нового.
",
"operationId": "admin-delete-attribute-value",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/value_external_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-attr-path-param"
}
],
"tags": [
"attribute-admin"
],
"responses": {
"204": {
"description": "Значение атрибута удалено успешно."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
}
}
}
}
},
"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
}
},
"external_id-group-path-param": {
"name": "external_id",
"in": "path",
"required": true,
"description": "[Внешний ID группы товаров](/ru/api/catalog/item-groups-admin/admin-create-item-group#item-groups-admin/admin-create-item-group/t=request&path=external_id), который был указан при создании.",
"schema": {
"type": "string",
"example": "weapons"
}
},
"group_id-path-param": {
"name": "group_id",
"in": "path",
"required": true,
"description": "ID группы.",
"schema": {
"type": "integer",
"example": 10
}
},
"item_sku-path-param": {
"name": "item_sku",
"in": "path",
"required": true,
"description": "Артикул товара.",
"schema": {
"type": "string",
"example": "booster_mega_1"
}
},
"virtual_currency_sku-path-param": {
"name": "virtual_currency_sku",
"in": "path",
"required": true,
"description": "Артикул виртуальной валюты.",
"schema": {
"type": "string",
"example": "crystal"
}
},
"locale-query-param": {
"name": "locale",
"in": "query",
"required": false,
"description": "Язык ответа. Двухбуквенный код языка в нижнем регистре по стандарту ISO 639-1 (например, `en`). Коды локали из пяти символов (например, `en-US`) поддерживаются в полях локализации (например, `name`, `description`), но в ответах приводятся к двухбуквенному формату. Полный список поддерживаемых языков приведен в [документации](https://developers.xsolla.com/ru/doc/shop-builder/references/supported-languages/).",
"schema": {
"type": "string",
"default": "en"
}
},
"additional_fields-query-param": {
"name": "additional_fields[]",
"in": "query",
"required": false,
"description": "Дополнительные поля, которые будут включены в ответ. По умолчанию не возвращаются. Передайте нужные значения, чтобы получить их в ответе.",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"media_list",
"order",
"long_description",
"custom_attributes",
"item_order_in_group"
]
}
}
},
"country-query-param": {
"name": "country",
"in": "query",
"required": false,
"description": "Двухбуквенное обозначение страны в верхнем регистре согласно стандарту [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Ознакомьтесь со [списком стран, поддерживаемых Xsolla](https://developers.xsolla.com/ru/doc/shop-builder/references/supported-countries/), а также с процессом [определения страны](https://developers.xsolla.com/ru/doc/shop-builder/features/pricing-policy/#pricing_policy_country_determination).",
"schema": {
"type": "string",
"example": "US"
}
},
"promo_code-query-param": {
"name": "promo_code",
"in": "query",
"required": false,
"description": "Уникальный код, чувствительный к регистру. Содержит буквы и цифры.",
"schema": {
"type": "string",
"example": "WINTER2021",
"minLength": 1,
"maxLength": 128
}
},
"show_inactive_time_limited_items-query-param": {
"name": "show_inactive_time_limited_items",
"in": "query",
"required": false,
"description": "Отображает предметы с ограниченным сроком действия, которые недоступны пользователю. Срок действия таких предметов еще не начался или уже истек.",
"schema": {
"type": "integer",
"example": 1,
"default": 0
}
},
"virtual_currency_package_sku-path-param": {
"name": "virtual_currency_package_sku",
"in": "path",
"required": true,
"description": "Артикул пакета виртуальной валюты.",
"schema": {
"type": "string",
"example": "crystal-pack"
}
},
"with_geo-query-param": {
"name": "with_geo",
"in": "query",
"required": false,
"description": "Возвращать ли информацию о локали и стране пользователя в заголовках ответа. Если установлено значение `true`, ответ включает заголовки `X-User-Locale-Code` и `X-User-Country-Code`.",
"schema": {
"type": "boolean",
"default": false
}
},
"item_type-group-path-param": {
"name": "item_type",
"in": "path",
"required": true,
"description": "Тип товара для фильтрации групп. Определяет, какие товары учитываются в `items_count`.Значения, содержащие символ `/` (например, `virtual_currency/package` или `game/key`), должны быть закодированы в URL-адресе (например, `virtual_currency%2Fpackage`).",
"schema": {
"type": "string",
"enum": [
"virtual_items",
"virtual_currency",
"virtual_currency/package",
"game/key",
"bundle",
"game",
"value_points",
"subscription_plans"
],
"example": "virtual_items"
}
},
"id-group-path-param": {
"name": "id",
"in": "path",
"required": true,
"description": "ID группы товаров, назначенный Xsolla.",
"schema": {
"type": "integer",
"example": 1
}
},
"platform-query-param": {
"name": "platform",
"in": "query",
"required": false,
"description": "Платформа публикации, на которой играет пользователь: `xsolla` (по умолчанию), `playstation_network`, `xbox_live`, `pc_standalone`, `nintendo_shop`, `google_play`, `app_store_ios`, `android_standalone`, `ios_standalone`, `android_other`, `ios_other`, `pc_other`.",
"schema": {
"type": "string",
"enum": [
"playstation_network",
"xbox_live",
"xsolla",
"pc_standalone",
"nintendo_shop",
"google_play",
"app_store_ios",
"android_standalone",
"ios_standalone",
"android_other",
"ios_other",
"pc_other"
],
"default": "xsolla"
}
},
"item_id-path-param": {
"name": "item_id",
"in": "path",
"required": true,
"description": "ID предмета (артикул).",
"schema": {
"type": "string",
"example": "656"
}
},
"user_email-query-param": {
"name": "user_email",
"in": "query",
"required": true,
"description": "Email-адрес пользователя.",
"schema": {
"type": "string",
"example": "email@email.com"
}
},
"quantity-query-param": {
"name": "quantity",
"in": "query",
"required": true,
"description": "Количество кодов.",
"schema": {
"type": "integer",
"example": 100
}
},
"reason-query-param": {
"name": "reason",
"in": "query",
"required": true,
"description": "Причина получения кодов.",
"schema": {
"type": "string",
"example": "Very important"
}
},
"region_id-query-param": {
"name": "region_id",
"in": "query",
"required": false,
"description": "ID региона.",
"schema": {
"type": "integer",
"default": 1
}
},
"sandbox-query-param": {
"name": "sandbox",
"in": "query",
"required": false,
"description": "Какой тип прав владения должен быть возвращен. Если параметру присвоено значение 1, возвращаются права владения, полученные пользователем только в режиме тестового окружения. Если параметр не передан или установлен в 0, возвращаются права владения, полученные пользователем только в режиме боевого окружения.",
"schema": {
"type": "integer",
"default": 0
}
},
"additional_fields-entitlement-query-param": {
"name": "additional_fields[]",
"in": "query",
"required": false,
"description": "Список дополнительных полей. Эти поля будут в ответе, если вы отправите их в своем запросе. Доступные поля: `attributes`.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"sku-path-param": {
"name": "sku",
"in": "path",
"required": true,
"description": "Артикул бандла.",
"schema": {
"type": "string",
"example": "kg_1"
}
},
"cart_id-path-param": {
"name": "cart_id",
"in": "path",
"required": true,
"description": "ID корзины.",
"schema": {
"type": "string",
"example": "custom_id"
}
},
"currency-query-param": {
"name": "currency",
"in": "query",
"required": false,
"description": "Валюта, в которой указаны цены товаров в корзине. Трехбуквенный код валюты в соответствии с [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Подробную информацию о [валютах, поддерживаемых Xsolla, смотрите в документации](https://developers.xsolla.com/ru/doc/pay-station/references/supported-currencies/).",
"schema": {
"type": "string",
"default": "USD"
}
},
"order_id-path-param": {
"name": "order_id",
"in": "path",
"required": true,
"description": "ID заказа.",
"schema": {
"type": "string",
"example": "656"
}
},
"x-user-for-header": {
"in": "header",
"name": "x-user-for",
"example": "ACCESS_TOKEN/LOGIN_JWT",
"schema": {
"type": "string"
},
"required": false,
"description": "Идентификатор пользователя может быть передан с помощью JWT пользователя Авторизации Иксолла или [токена доступа Платежей Иксолла](https://developers.xsolla.com/ru/pay-station-api/current/token/create-token))."
},
"x-user-id-header": {
"in": "header",
"name": "x-user-id",
"example": "UNIQUE_ID",
"schema": {
"maxLength": 32,
"type": "string"
},
"required": false,
"description": "Вы можете использовать свой собственный ID пользователя при продаже корзины с играми."
},
"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"
}
},
"merchant_id-path-param": {
"name": "merchant_id",
"in": "path",
"required": true,
"description": "ID продавца.",
"schema": {
"type": "integer",
"example": 121212
}
},
"project_id_59080-path-param": {
"name": "project_id",
"in": "path",
"required": true,
"description": "ID проекта. Вы можете найти этот параметр в [Личном кабинете](https://publisher.xsolla.com/) рядом с названием проекта.",
"schema": {
"type": "integer",
"example": 59080
}
},
"item_id_59080-path-param": {
"name": "item_id",
"in": "path",
"required": true,
"description": "ID предмета (артикул).",
"schema": {
"type": "string",
"example": "259774"
}
},
"item_sku_59080-path-param": {
"name": "sku",
"in": "path",
"required": true,
"description": "Артикул товара.",
"schema": {
"type": "string",
"example": "electric_shield"
}
},
"external_id_59080-group-path-param": {
"name": "external_id",
"in": "path",
"required": true,
"description": "External ID группы.",
"schema": {
"type": "string",
"default": "armour"
}
},
"region_id-path-param": {
"name": "region_id",
"in": "path",
"required": true,
"description": "ID региона. Уникальный идентификатор региона в рамках проекта.",
"schema": {
"type": "integer",
"example": 42
}
},
"external_id-attr-path-param": {
"name": "external_id",
"in": "path",
"required": true,
"description": "External ID атрибута.",
"schema": {
"type": "string",
"example": "attribute_id"
}
},
"value_external_id-path-param": {
"name": "value_external_id",
"in": "path",
"required": true,
"description": "External ID значения атрибута.",
"schema": {
"type": "string",
"pattern": "^[-_\\.\\d\\w]+$",
"example": "value_id"
}
}
},
"schemas": {
"Virtual-Items-Currency_sku": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9_\\-–.]*$",
"example": "booster_mega_1",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"admin-attribute-external_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9-_]+$",
"example": "attribute_1",
"description": "Уникальный ID атрибута. `external_id` может содержать только строчные и заглавные латинские буквы, цифры, тире и подчеркивания."
},
"admin-attribute-name": {
"type": "object",
"description": "Объект с локализациями для названия атрибута. Ключи для обозначения стран указаны в стандарте ISO 3166-1.",
"additionalProperties": {
"type": "string"
},
"example": {
"en": "Genre",
"de": "Genre"
},
"default": {
"en": "Genre",
"de": "Genre"
}
},
"value-external_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[-_.\\d\\w]+$",
"example": "attribute_value",
"description": "Уникальный ID значения атрибута. `external_id` может содержать только строчные латинские буквы, цифры, тире и подчеркивания."
},
"value-name": {
"type": "object",
"description": "Объект с локализациями для названия значения. Ключи для обозначения стран указаны в стандарте ISO 3166-1.",
"additionalProperties": {
"type": "string"
},
"example": {
"en": "Strategy",
"de": "Strategie"
},
"default": {
"en": "Strategy",
"de": "Strategie"
}
},
"attribute-value": {
"type": "object",
"required": [
"value",
"external_id"
],
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
},
"value": {
"$ref": "#/components/schemas/value-name"
}
},
"example": {
"external_id": "value_external_id",
"name": {
"en": "Value 1",
"de": "Wert 1"
}
}
},
"attribute": {
"type": "object",
"required": [
"external_id",
"values"
],
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"$ref": "#/components/schemas/admin-attribute-name"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/attribute-value"
},
"example": [
{
"external_id": "strategy",
"value": {
"en": "Strategy",
"de": "Strategie"
}
},
{
"external_id": "action",
"value": {
"en": "Action",
"de": "Aktion"
}
}
]
}
},
"example": {
"external_id": "attribute_external_id",
"name": {
"en": "Attribute name",
"de": "Attributname"
},
"values": [
{
"external_id": "value_1",
"name": {
"en": "value 1",
"de": "wert 1"
}
},
{
"external_id": "value_2",
"name": {
"en": "value 2",
"de": "wert 2"
}
}
]
}
},
"Virtual-Items-Currency_schemas-admin-attributes": {
"type": "array",
"description": "Список атрибутов.",
"items": {
"$ref": "#/components/schemas/attribute"
}
},
"Virtual-Items-Currency_admin-attributes": {
"allOf": [
{
"$ref": "#/components/schemas/Virtual-Items-Currency_schemas-admin-attributes"
},
{
"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"
}
]
},
"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_admin-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": "Ссылка на файл."
}
}
}
},
"Virtual-Items-Currency_type": {
"type": "string",
"description": "Тип товара: `virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`."
},
"Virtual-Items_admin-prices": {
"type": "array",
"items": {
"type": "object",
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"description": "Сумма.",
"type": "number",
"exclusiveMinimum": 0
},
"currency": {
"type": "string",
"example": "USD",
"description": "Валюта, в которой указана цена товара. Трехбуквенный код в соответствии с [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Подробную информацию о [валютах, поддерживаемых Xsolla, смотрите в документации](https://developers.xsolla.com/ru/doc/pay-station/references/supported-currencies/)."
},
"country_iso": {
"type": "string",
"description": "Двухбуквенное обозначение страны в верхнем регистре согласно стандарту [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Список стран, поддерживаемых Xsolla, [приведен в документации](https://developers.xsolla.com/ru/doc/shop-builder/references/supported-countries/).
Пример: `country=US`",
"example": "US"
},
"is_default": {
"type": "boolean",
"default": false
},
"is_enabled": {
"type": "boolean",
"default": true
}
},
"example": {
"currency": "USD",
"amount": 10.5,
"is_default": true,
"is_enabled": true
}
}
},
"Virtual-Items-Currency_schemas-sku": {
"type": "string",
"example": "bundle_1",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"Virtual-Items-Currency_admin-get-vc_prices": {
"type": "array",
"items": {
"type": "object",
"required": [
"sku",
"amount"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_schemas-sku"
},
"amount": {
"description": "Сумма.",
"type": "number",
"exclusiveMinimum": 0
},
"is_default": {
"type": "boolean",
"default": false
}
},
"example": {
"sku": "com.xsolla.gold_1",
"amount": 10,
"is_default": true
}
}
},
"Virtual-Items-Currency_admin-image_url": {
"type": "string",
"description": "URL-адрес изображения. Для корректного отображения и быстрой загрузки изображения в платежном интерфейсе проверьте требования к файлу и ссылке:- Поддерживаемые форматы: WebP (рекомендуется), PNG, JPG.
- Размер файла: ≤ 50 КБ (для WebP) или ≤ 150 КБ (для PNG и JPG).
- Размер изображения: 280 x 280 px.
- Цветовое пространство: sRGB.
- Протокол передачи данных: HTTPS с долгосрочным кэшированием версионированных URL-адресов.
"
},
"value-is_free": {
"type": "boolean",
"example": false,
"default": false,
"description": "Является ли товар бесплатным."
},
"value-is_paid_randomized_reward": {
"type": "boolean",
"example": false,
"default": false,
"description": "Является ли товар случайной платной наградой, например лутбоксом."
},
"Virtual-Items-Currency_order": {
"type": "integer",
"example": 1,
"default": 1,
"description": "Порядок для отображения товара в каталоге. Чем больше значение, тем ниже товар отображается в списке. При одинаковом значении товары сортируются по дате создания – более новые товары отображаются выше."
},
"Virtual-Items-Currency_is_enabled": {
"type": "boolean",
"example": true,
"default": true,
"description": "Доступен ли товар. Если `false`, товар нельзя купить в магазине или получить в составе бандла или в рамках маркетинговой акции. Подробная информация о доступности товара приведена в [документации](https://developers.xsolla.com/ru/items-catalog/catalog-features/items-availability/)."
},
"Virtual-Items-Currency_is_show_in_store": {
"type": "boolean",
"example": true,
"default": false,
"description": "Отображается ли товар в каталоге. Если `false` и `is_enabled: true`, товар не отображается в каталоге, но может быть получен в составе бандла или в рамках маркетинговой акции. Подробная информация о доступности товара приведена в [документации](https://developers.xsolla.com/ru/items-catalog/catalog-features/items-availability/)."
},
"Virtual-Items-Currency_admin-regions": {
"description": "Список регионов, в которых доступен товар. Если массив пустой или не передан, товар доступен во всех регионах.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1,
"example": 1,
"description": "ID региона в рамках проекта.\n\nПодробная информация приведена в [документации по региональным ограничениям продаж](https://developers.xsolla.com/ru/items-catalog/catalog-features/regional-restrictions/) и [методам API управления регионами](https://developers.xsolla.com/ru/api/catalog/common-regions)."
}
}
}
},
"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"
},
"admin_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": "object",
"title": "interval_type = hourly",
"description": "Сброс ограничений для пользователя, выполняемый через временной интервал, заданный в часах.",
"properties": {
"interval_type": {
"type": "string",
"description": "Период обновления ограничения на продажу товара.",
"enum": [
"hourly"
]
},
"hours_interval": {
"type": "integer",
"description": "Интервал в часах, через который обновляется лимит покупок товара.
Отсчет начинается с момента, когда товар впервые отображается в магазине — задается в параметре date_from.
Например, если `date_from = \"2025-11-15T18:15:00+05:00\"` и `hours_interval = 2`, лимит покупок для этого товара будет обновляться каждые 2 часа, начиная с `\"2025-11-15T20:15:00+05:00\"`.",
"minimum": 1,
"maximum": 10000
},
"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"
}
]
}
}
},
"admin-item-limit-response": {
"type": [
"object",
"null"
],
"description": "Ограничения на продажу товара.",
"properties": {
"per_user": {
"type": [
"object",
"null"
],
"description": "Ограничение количества товара для отдельного пользователя.",
"properties": {
"total": {
"type": "integer",
"description": "Максимальное количество товара, которое может приобрести один пользователь."
},
"limit_exceeded_visibility": {
"$ref": "#/components/schemas/limit_exceeded_visibility"
}
}
},
"per_item": {
"type": [
"object",
"null"
],
"description": "Глобальное ограничение товара.",
"properties": {
"total": {
"type": "integer",
"description": "Максимальное количество товара, которое могут приобрести все пользователи."
},
"available": {
"type": "integer",
"description": "Оставшееся количество товара, которое могут приобрести все пользователи."
},
"reserved": {
"type": "integer"
},
"sold": {
"type": "integer"
}
}
},
"recurrent_schedule": {
"$ref": "#/components/schemas/admin_recurrent_schedule_response"
}
}
},
"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"
},
"Virtual-Items-Currency_admin-virtual-item": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-attributes"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-response"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"type": {
"$ref": "#/components/schemas/Virtual-Items-Currency_type"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items_admin-prices"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-get-vc_prices"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
}
}
},
"Virtual-Items-Currency_schemas-admin-image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "URL-адрес изображения. Для корректного отображения и быстрой загрузки изображения в платежном интерфейсе проверьте требования к файлу и ссылке:- Поддерживаемые форматы: WebP (рекомендуется), PNG, JPG.
- Размер файла: ≤ 50 КБ (для WebP) или ≤ 150 КБ (для PNG и JPG).
- Размер изображения: 280 x 280 px.
- Цветовое пространство: sRGB.
- Протокол передачи данных: HTTPS с долгосрочным кэшированием версионированных URL-адресов.
"
},
"Virtual-Items-Currency_admin-groups-create": {
"type": "array",
"description": "Список [внешних ID групп](/ru/api/catalog/item-groups-admin/admin-get-item-group-list/#!path=groups/external_id&t=response), к которым относится товар.\n\nПример: [\"horror\", \"action\"]",
"items": {
"type": "string",
"properties": {
"external_id": {
"type": "string",
"example": "accessory"
},
"name": {
"type": "string",
"example": "Accessory"
}
}
}
},
"admin-post-put-attribute-item": {
"type": "object",
"required": [
"external_id",
"values"
],
"maxItems": 6,
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"$ref": "#/components/schemas/admin-attribute-name"
},
"values": {
"type": "array",
"description": "Внимание. Невозможно создать более 6 значений для каждого атрибута. Любые попытки превысить данное ограничение вызовут ошибку.
",
"items": {
"$ref": "#/components/schemas/attribute-value"
},
"example": [
{
"external_id": "strategy",
"value": {
"en": "Strategy",
"de": "Strategie"
}
},
{
"external_id": "action",
"value": {
"en": "Action",
"de": "Aktion"
}
}
]
}
}
},
"Virtual-Items-Currency_admin-post-put-attributes": {
"type": "array",
"maxItems": 20,
"description": "Список атрибутов.\n\nВнимание. Для товара невозможно указать более 20 атрибутов. Любые попытки превысить данное ограничение вызовут ошибку.
",
"items": {
"$ref": "#/components/schemas/admin-post-put-attribute-item"
}
},
"Virtual-Items-Currency_admin-create-vc_prices": {
"description": "Массив цен в виртуальной валюте.",
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_schemas-sku"
},
"amount": {
"type": "integer",
"description": "Цена товара в виртуальной валюте."
},
"is_default": {
"type": "boolean",
"default": false,
"description": "Является ли ценой в виртуальной валюте по умолчанию."
},
"is_enabled": {
"type": "boolean",
"default": true,
"description": "Используется ли эта цена для отображения в каталоге и покупки товара. Если `false`, цена не используется."
}
},
"required": [
"amount",
"sku",
"is_default",
"is_enabled"
],
"example": {
"sku": "com.xsolla.gold_1",
"amount": 10,
"is_default": true,
"is_enabled": true
}
}
},
"limit_per_user": {
"description": "Ограничение количества товара для отдельного пользователя.",
"anyOf": [
{
"type": "null",
"description": "Нет ограничений на покупку товаров для пользователя."
},
{
"type": "integer",
"description": "Максимальное количество товара, которое может приобрести один пользователь.",
"example": 5
},
{
"type": "object",
"description": "Detailed purchase limit configuration.",
"properties": {
"total": {
"type": "integer",
"description": "Максимальное количество товара, которое может приобрести один пользователь.",
"example": 5
},
"limit_exceeded_visibility": {
"$ref": "#/components/schemas/limit_exceeded_visibility"
}
}
}
]
},
"limit_per_item": {
"type": [
"integer",
"null"
],
"description": "Глобальное ограничение товара.",
"example": 10
},
"per_user_daily": {
"type": "object",
"title": "interval_type = daily",
"description": "Ежедневное обновление пользовательских ограничений.",
"properties": {
"interval_type": {
"type": "string",
"description": "Период обновления ограничений.",
"enum": [
"daily"
]
},
"time": {
"type": "string",
"description": "Время обновления ограничений в желаемом часовом поясе (округление до часов).",
"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": "02:00:00+03:00"
}
},
"required": [
"interval_type",
"time"
]
},
"per_user_weekly": {
"type": "object",
"title": "interval_type = weekly",
"description": "Еженедельное обновление пользовательских ограничений.",
"properties": {
"interval_type": {
"type": "string",
"description": "Период обновления ограничений.",
"enum": [
"weekly"
]
},
"day_of_week": {
"type": "integer",
"description": "День недели, когда обновляются ограничения: 1 — понедельник, 7 — воскресенье.",
"minimum": 1,
"maximum": 7
},
"time": {
"type": "string",
"description": "Время обновления ограничений в желаемом часовом поясе (округление до часов).",
"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": "11:00:00+03:00"
}
}
},
"per_user_monthly": {
"type": "object",
"title": "interval_type = monthly",
"description": "Ежемесячное обновление пользовательских ограничений.",
"properties": {
"interval_type": {
"type": "string",
"description": "Период обновления ограничений.",
"enum": [
"monthly"
]
},
"day_of_month": {
"type": "integer",
"description": "День месяца, когда обновляются ограничения. Если в месяце нет выбранного дня, поскольку он короче, то обновление произойдет в последний день месяца.",
"minimum": 1,
"maximum": 31
},
"time": {
"type": "string",
"description": "Время обновления ограничений в желаемом часовом поясе (округление до часов).",
"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": "23:00:00+03:00"
}
},
"required": [
"interval_type",
"time",
"day_of_month"
]
},
"interval_type_hourly": {
"type": "string",
"description": "Период обновления ограничений.",
"enum": [
"hourly"
]
},
"hours_interval": {
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"per_user_hourly_vi": {
"type": "object",
"title": "interval_type = hourly",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/interval_type_hourly"
},
"hours_interval": {
"allOf": [
{
"$ref": "#/components/schemas/hours_interval"
},
{
"description": "Интервал в часах, через который обновляется лимит покупок товара.
Отсчет начинается с момента, когда товар впервые отображается в магазине — задается в параметре date_from.
Например, если `date_start = \"2025-11-15T18:15:00+05:00\"` и `hours_interval = 2`, лимит покупок для этого товара будет обновляться каждые 2 часа, начиная с `\"2025-11-15T20:15:00+05:00\"`."
}
]
}
},
"required": [
"interval_type",
"hours_interval"
]
},
"virtual_item_recurrent_schedule": {
"type": [
"object",
"null"
],
"description": "Период обновления установленный ограничений.",
"properties": {
"per_user": {
"description": "Сброс лимитов на покупку товара, выполняемый через временной интервал, заданный в часах.",
"oneOf": [
{
"$ref": "#/components/schemas/per_user_daily"
},
{
"$ref": "#/components/schemas/per_user_weekly"
},
{
"$ref": "#/components/schemas/per_user_monthly"
},
{
"$ref": "#/components/schemas/per_user_hourly_vi"
}
]
}
}
},
"Virtual-Item-item-limit": {
"type": "object",
"description": "Ограничения на продажу товара.",
"properties": {
"per_user": {
"$ref": "#/components/schemas/limit_per_user"
},
"per_item": {
"$ref": "#/components/schemas/limit_per_item"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/virtual_item_recurrent_schedule"
}
}
},
"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`."
}
}
}
},
"item-custom-attributes": {
"type": "object",
"description": "JSON-объект, содержащий атрибуты товара и их значения. Атрибуты позволяют добавить дополнительную информацию к товарам. Например, указать уровень игрока, на котором ему станет доступен этот товар. Атрибуты дополняют внутреннюю логику игры и могут быть получены через GET-методы и вебхуки.",
"format": "json",
"maxLength": 500
},
"Virtual-Items-Currency_admin-create-virtual-item": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"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/Virtual-Items-Currency_schemas-admin-image_url"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-create"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-post-put-attributes"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items_admin-prices"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-vc_prices"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/Virtual-Item-item-limit"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes"
}
}
},
"Virtual-Items-Currency_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 `property_name` is required"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
},
"errorMessageExtended": {
"type": "array"
}
}
},
"Virtual-Items-Currency_admin-prices": {
"type": "array",
"items": {
"type": "object",
"required": [
"amount",
"currency"
],
"properties": {
"currency": {
"type": "string",
"example": "USD",
"description": "Валюта, в которой указана цена товара. Трехбуквенный код в соответствии с [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Подробную информацию о [валютах, поддерживаемых Xsolla, смотрите в документации](https://developers.xsolla.com/ru/doc/pay-station/references/supported-currencies/)."
},
"amount": {
"type": "number",
"exclusiveMinimum": 0,
"example": 10.5,
"description": "Цена товара в реальной валюте."
},
"is_default": {
"type": "boolean",
"default": false,
"description": "Является ли ценой в реальной валюте по умолчанию. Подробная информация по настройке цен приведена в [документации](https://developers.xsolla.com/ru/items-catalog/catalog-features/pricing-policy/#pricing_policy_country_determination)."
},
"is_enabled": {
"type": "boolean",
"default": true,
"example": true,
"description": "Используется ли эта цена для отображения в каталоге и покупки товара. Если `false`, цена не используется, и применяется другая цена. Подробная информация по настройке цен приведена в [документации](https://developers.xsolla.com/ru/items-catalog/catalog-features/pricing-policy/#pricing_policy_country_determination)."
},
"country_iso": {
"type": [
"string",
"null"
],
"example": "US",
"description": "Страна, где доступна эта цена. Двухбуквенный код в соответствии с [ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)."
}
},
"example": {
"currency": "USD",
"amount": 10.5,
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
}
},
"Virtual-Items-Currency_admin-virtual-currency": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-attributes"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"type": {
"$ref": "#/components/schemas/Virtual-Items-Currency_type"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-get-vc_prices"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
}
}
},
"per_user_hourly_vc": {
"type": "object",
"title": "interval_type = hourly",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/interval_type_hourly"
},
"hours_interval": {
"allOf": [
{
"$ref": "#/components/schemas/hours_interval"
},
{
"description": "Интервал в часах, через который обновляется лимит покупок товара.
Отсчет начинается с момента, когда товар впервые отображается в магазине — задается в параметре date_from.
Например, если `date_start = \"2025-11-15T18:15:00+05:00\"` и `hours_interval = 2`, лимит покупок для этого товара будет обновляться каждые 2 часа, начиная с `\"2025-11-15T20:15:00+05:00\"`."
}
]
}
},
"required": [
"interval_type",
"hours_interval"
]
},
"virtual_currency_recurrent_schedule": {
"type": [
"object",
"null"
],
"description": "Период обновления установленный ограничений.",
"properties": {
"per_user": {
"description": "Сброс лимитов на покупку товара, выполняемый через временной интервал, заданный в часах.",
"oneOf": [
{
"$ref": "#/components/schemas/per_user_daily"
},
{
"$ref": "#/components/schemas/per_user_weekly"
},
{
"$ref": "#/components/schemas/per_user_monthly"
},
{
"$ref": "#/components/schemas/per_user_hourly_vc"
}
]
}
}
},
"Virtual-Currency-item-limit": {
"type": "object",
"description": "Ограничения на продажу товара.",
"properties": {
"per_user": {
"$ref": "#/components/schemas/limit_per_user"
},
"per_item": {
"$ref": "#/components/schemas/limit_per_item"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/virtual_currency_recurrent_schedule"
}
}
},
"Virtual-Items-Currency_admin-create-virtual-currency": {
"type": "object",
"required": [
"sku",
"name"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"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/Virtual-Items-Currency_admin-image_url"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-create"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-post-put-attributes"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-vc_prices"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/Virtual-Currency-item-limit"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes"
}
}
},
"Virtual-Items-Currency_admin-virtual-currency-package": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"type": {
"$ref": "#/components/schemas/Virtual-Items-Currency_type"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-attributes"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-response"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-get-vc_prices"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"bundle_type": {
"type": "string",
"default": "virtual_currency_package",
"example": "virtual_currency_package"
},
"content": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url"
},
"type": {
"$ref": "#/components/schemas/Virtual-Items-Currency_type"
},
"quantity": {
"type": "integer"
}
}
}
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes"
}
}
},
"per_user_hourly_vcp": {
"type": "object",
"title": "interval_type = hourly",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/interval_type_hourly"
},
"hours_interval": {
"allOf": [
{
"$ref": "#/components/schemas/hours_interval"
},
{
"description": "Интервал в часах, через который обновляется лимит покупок товара.
Отсчет начинается с момента, когда товар впервые отображается в магазине — задается в параметре date_from.
Например, если `date_start = \"2025-11-15T18:15:00+05:00\"` и `hours_interval = 2`, лимит покупок для этого товара будет обновляться каждые 2 часа, начиная с `\"2025-11-15T20:15:00+05:00\"`."
}
]
}
},
"required": [
"interval_type",
"hours_interval"
]
},
"virtual_currency_package_recurrent_schedule": {
"type": [
"object",
"null"
],
"description": "Период обновления установленный ограничений.",
"properties": {
"per_user": {
"description": "Сброс лимитов на покупку товара, выполняемый через временной интервал, заданный в часах.",
"oneOf": [
{
"$ref": "#/components/schemas/per_user_daily"
},
{
"$ref": "#/components/schemas/per_user_weekly"
},
{
"$ref": "#/components/schemas/per_user_monthly"
},
{
"$ref": "#/components/schemas/per_user_hourly_vcp"
}
]
}
}
},
"Virtual-Currency-Package-item-limit": {
"type": "object",
"description": "Ограничения на продажу товара.",
"properties": {
"per_user": {
"$ref": "#/components/schemas/limit_per_user"
},
"per_item": {
"$ref": "#/components/schemas/limit_per_item"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/virtual_currency_package_recurrent_schedule"
}
}
},
"Virtual-Items-Currency_admin-create-virtual-currency-package": {
"type": "object",
"required": [
"sku",
"name",
"description",
"content"
],
"anyOf": [
{
"required": [
"prices"
]
},
{
"required": [
"vc_prices"
]
}
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"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/Virtual-Items-Currency_admin-image_url"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-create"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-post-put-attributes"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-vc_prices"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"content": {
"type": "array",
"minLength": 1,
"maxLength": 1,
"description": "Пакет виртуальной валюты должен содержать только 1 позицию виртуальной валюты.",
"items": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"quantity": {
"type": "integer"
}
}
}
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/Virtual-Currency-Package-item-limit"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes"
}
}
},
"Pagination_has-more": {
"type": "boolean",
"example": true,
"description": "Используется как индикатор того, что остались еще страницы."
},
"items_client_groups_response": {
"type": "array",
"example": [
{
"external_id": "exclusive",
"name": "Exclusive"
}
],
"default": [],
"description": "Группы, к которым принадлежит товар.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"description": "[Внешний ID группы товаров](/ru/api/catalog/item-groups-admin/admin-create-item-group#item-groups-admin/admin-create-item-group/t=request&path=external_id), который был указан при создании.",
"example": "exclusive"
},
"name": {
"type": "string",
"description": "Название группы.",
"example": "Exclusive"
},
"item_order_in_group": {
"type": "integer",
"description": "Позиция предмета внутри группы, определяющая порядок отображения.\nВозвращается в ответ только при указании в запросе query-параметра `additional_fields[]`.",
"example": 1
}
}
}
},
"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": "Описание виртуальной валюты."
}
}
}
},
"Can_be_bought": {
"type": "boolean",
"example": true,
"description": "Если `true`, пользователь может купить товар."
},
"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"
}
}
}
}
}
}
}
},
"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"
}
]
},
"client-item-limit-response": {
"type": [
"object",
"null"
],
"description": "Ограничения на продажу товара.",
"properties": {
"per_user": {
"type": [
"object",
"null"
],
"description": "Ограничение количества товара для отдельного пользователя.",
"properties": {
"total": {
"type": "integer",
"description": "Максимальное количество товара, которое может приобрести один пользователь."
},
"available": {
"type": "integer",
"description": "Оставшееся количество товара, которое может приобрести текущий пользователь."
},
"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": "Максимальное количество товара, которое могут приобрести все пользователи."
},
"available": {
"type": "integer",
"description": "Оставшееся количество товара, которое могут приобрести все пользователи."
}
}
}
}
},
"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": "Количество баллов лояльности, которое пользователь получает за покупку товара."
}
}
}
},
"item-loyalty-point-prices": {
"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": "Цена товара в указанных баллах лояльности."
}
}
}
},
"Virtual-Items-Currency_item": {
"type": "object",
"properties": {
"item_id": {
"type": "number",
"description": "ID предмета (артикул)."
},
"sku": {
"type": "string",
"example": "big_rocket",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"name": {
"type": "object",
"example": "Big Rocket",
"description": "Название товара.",
"additionalProperties": {
"type": [
"string",
"null"
]
}
},
"groups": {
"$ref": "#/components/schemas/items_client_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": "object",
"example": "Big Rocket - description",
"description": "Описание товара.",
"additionalProperties": {
"type": [
"string",
"null"
]
}
},
"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). Подробную информацию о [валютах, поддерживаемых Xsolla, смотрите в документации](https://developers.xsolla.com/ru/doc/pay-station/references/supported-currencies/)."
}
}
},
"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/client-item-limit-response"
},
"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"
},
"loyalty_rewards": {
"$ref": "#/components/schemas/item-loyalty-point-reward"
},
"loyalty_prices": {
"$ref": "#/components/schemas/item-loyalty-point-prices"
}
}
},
"Virtual-Items-Currency_item-list": {
"type": "object",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_item"
}
}
}
},
"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"
]
},
"Virtual-Items-Currency_virtual-currency": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"description": "Уникальный ID товара, назначенный Xsolla."
},
"sku": {
"type": "string",
"example": "crystal",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"name": {
"type": "string",
"example": "Crystals",
"description": "Название товара."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "Тип товара: `virtual_good`/`virtual_currency`/`bundle`."
},
"description": {
"type": "string",
"example": "Crystals - 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). Подробную информацию о [валютах, поддерживаемых Xsolla, смотрите в документации](https://developers.xsolla.com/ru/doc/pay-station/references/supported-currencies/)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response",
"example": [
{
"amount": 100,
"sku": "com.xsolla.crystals_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png"
}
]
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"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"
},
"loyalty_rewards": {
"$ref": "#/components/schemas/item-loyalty-point-reward"
},
"loyalty_prices": {
"$ref": "#/components/schemas/item-loyalty-point-prices"
}
}
},
"Virtual-Items-Currency_virtual-currency-list": {
"type": "object",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency"
}
}
}
},
"Virtual-Items-Currency_virtual-currency-package": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"description": "Уникальный ID товара, назначенный Xsolla."
},
"sku": {
"type": "string",
"example": "crystal-pack",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"name": {
"type": "string",
"example": "Crystal Pack",
"description": "Название товара."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "bundle",
"description": "Тип товара: `virtual_good`/`virtual_currency`/`bundle`."
},
"bundle_type": {
"type": "string",
"example": "virtual_currency_package",
"description": "Тип бандла. Для пакетов виртуальной валюты всегда имеет значение `virtual_currency_package`."
},
"description": {
"type": "string",
"example": "Crystal Pack Description",
"description": "Описание товара."
},
"image_url": {
"type": "string",
"example": "https://cdn.xsolla.net/items/crystal-pack.png",
"description": "URL-адрес изображения."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"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). Подробную информацию о [валютах, поддерживаемых Xsolla, смотрите в документации](https://developers.xsolla.com/ru/doc/pay-station/references/supported-currencies/)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"content": {
"type": "array",
"example": [
{
"description": "Crystal - short description",
"image_url": "https://cdn.xsolla.net/items/crystal-pack.png",
"sku": "com.xsolla.crystal_1",
"name": "Crystals",
"type": "virtual_currency",
"quantity": 100
}
],
"description": "Содержимое пакета виртуальной валюты.",
"items": {
"type": "object",
"description": "Виртуальная валюта в пакете.",
"properties": {
"item_id": {
"type": "integer",
"description": "Уникальный ID товара, назначенный Xsolla."
},
"sku": {
"type": "string",
"example": "com.xsolla.crystal_1",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"name": {
"type": "string",
"example": "Crystals",
"description": "Название товара."
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "Тип товара. Для виртуальной валюты всегда имеет значение `virtual_currency`."
},
"description": {
"type": "string",
"example": "Crystals - description",
"description": "Описание товара."
},
"image_url": {
"type": "string",
"example": "https://cdn.xsolla.net/items/crystal-pack.png",
"description": "URL-адрес изображения."
},
"quantity": {
"type": "integer",
"example": 250,
"description": "Количество виртуальной валюты в пакете."
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
}
}
}
},
"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"
},
"loyalty_rewards": {
"$ref": "#/components/schemas/item-loyalty-point-reward"
},
"loyalty_prices": {
"$ref": "#/components/schemas/item-loyalty-point-prices"
}
}
},
"Virtual-Items-Currency_virtual-currency-packages": {
"type": "object",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-package"
}
}
}
},
"group-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"
}
]
},
"group-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"
}
]
},
"group-image-url": {
"type": [
"string",
"null"
],
"description": "URL-адрес изображения.",
"example": "https://example.com/weapons.png"
},
"group-display-order": {
"type": "integer",
"description": "Порядок для отображения группы товаров в каталоге. Чем больше значение, тем ниже группа отображается в списке. При одинаковом значении группы сортируются по дате создания – более новые группы отображаются выше.",
"default": 1,
"example": 1
},
"group-is-enabled": {
"type": "boolean",
"description": "Включено ли отображение группы товаров в каталоге.",
"example": true,
"default": true
},
"admin-group-response-base": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID группы товаров, назначенный Xsolla.",
"example": 1
},
"external_id": {
"type": "string",
"description": "Внешний ID группы товаров, который был указан при создании.",
"example": "weapons"
},
"name": {
"$ref": "#/components/schemas/group-name-localization-object"
},
"description": {
"$ref": "#/components/schemas/group-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/group-image-url"
},
"order": {
"$ref": "#/components/schemas/group-display-order"
},
"is_enabled": {
"$ref": "#/components/schemas/group-is-enabled"
},
"items_count": {
"type": "integer",
"description": "Общее количество товаров в группе.",
"example": 5
}
},
"required": [
"id",
"external_id",
"name",
"is_enabled"
]
},
"error-response-base": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"description": "HTTP-статус ответа."
},
"errorCode": {
"type": "integer",
"description": "Код ошибки."
},
"errorMessage": {
"type": "string",
"description": "Краткое описание ошибки."
},
"transactionId": {
"type": "string",
"description": "ID запроса. Позволяет отслеживать и связывать записи логов для этого запроса или операции. Может использоваться для диагностики, отладки и аудита."
}
}
},
"admin-group-create-request": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"description": "Внешний ID группы товаров.Может содержать только буквенно-цифровые символы, дефисы и подчеркивания.",
"pattern": "^[A-Za-z0-9_\\-]+$",
"example": "weapons"
},
"name": {
"$ref": "#/components/schemas/group-name-localization-object"
},
"description": {
"$ref": "#/components/schemas/group-description-localization-object"
},
"iconUrl": {
"$ref": "#/components/schemas/group-image-url"
},
"isEnabled": {
"allOf": [
{
"$ref": "#/components/schemas/group-is-enabled"
}
],
"default": true
},
"order": {
"allOf": [
{
"$ref": "#/components/schemas/group-display-order"
}
]
}
},
"description": "Данные группы товаров.",
"required": [
"external_id",
"name"
]
},
"error-message-extended-validation": {
"type": "array",
"description": "Детали ошибок валидации. Содержит массив ошибок на уровне полей с указанием, какие поля не прошли проверку и почему.",
"items": {
"type": "object",
"properties": {
"property": {
"type": "string",
"description": "Имя поля, не прошедшего валидацию.",
"example": "external_id"
},
"message": {
"type": "string",
"description": "Сообщение об ошибке валидации для поля.",
"example": "The property external_id is required"
}
}
}
},
"ItemGroup_422-invalid-request": {
"type": "object",
"required": [
"statusCode",
"errorCode",
"errorMessage",
"transactionId"
],
"properties": {
"statusCode": {
"type": "integer",
"description": "HTTP-статус ответа.",
"example": 422
},
"errorCode": {
"type": "integer",
"description": "Код ошибки.",
"example": 1102
},
"errorMessage": {
"type": "string",
"description": "Краткое описание ошибки.",
"example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required"
},
"transactionId": {
"type": "string",
"description": "ID запроса. Позволяет отслеживать и связывать записи логов для этого запроса или операции. Может использоваться для диагностики, отладки и аудита.",
"example": "x-x-x-x-transactionId-mock-x-x-x"
},
"errorMessageExtended": {
"$ref": "#/components/schemas/error-message-extended-validation"
}
}
},
"admin-group-update-request": {
"type": "object",
"properties": {
"name": {
"$ref": "#/components/schemas/group-name-localization-object"
},
"description": {
"$ref": "#/components/schemas/group-description-localization-object"
},
"external_id": {
"type": "string",
"description": "Внешний ID группы товаров. Может содержать только буквенно-цифровые символы, дефисы и подчеркивания.",
"pattern": "^[A-Za-z0-9_\\-]+$",
"example": "weapons"
},
"iconUrl": {
"$ref": "#/components/schemas/group-image-url"
},
"isEnabled": {
"allOf": [
{
"$ref": "#/components/schemas/group-is-enabled"
}
]
},
"order": {
"allOf": [
{
"$ref": "#/components/schemas/group-display-order"
}
]
}
},
"description": "Item group data to update. The `external_id` and `name` fields are required in every request. Other fields are optional — omitted fields will retain their current values.",
"required": [
"external_id",
"name"
]
},
"group-is-contains-any-items": {
"type": "boolean",
"description": "Содержит ли группа какие-либо товары независимо от запрошенного `item_type`. Для указанного типа может быть возвращено значение `items_count: 0`, при этом `is_contains_any_items` будет равно `true`, если в группе есть товары других типов.",
"example": true
},
"admin-group-response-by-item-type": {
"allOf": [
{
"$ref": "#/components/schemas/admin-group-response-base"
},
{
"type": "object",
"properties": {
"is_contains_any_items": {
"$ref": "#/components/schemas/group-is-contains-any-items"
}
}
}
]
},
"admin-group-detail-response-by-item-type": {
"allOf": [
{
"$ref": "#/components/schemas/admin-group-response-base"
},
{
"type": "object",
"properties": {
"is_contains_any_items": {
"$ref": "#/components/schemas/group-is-contains-any-items"
}
}
}
]
},
"item-in-group-order-request-item": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"description": "Внутренний ID товара, назначенный Xsolla. Используйте ID товара, полученный в ответах [методов получения каталога товаров](/ru/api/catalog/common-catalog).",
"minimum": 0,
"example": 101
},
"order": {
"type": "integer",
"description": "Новое значение порядка сортировки.",
"minimum": 0,
"example": 1
}
},
"required": [
"item_id",
"order"
],
"additionalProperties": false
},
"Cart-Payment_custom_parameters": {
"description": "Ваши пользовательские параметры представлены в виде допустимого набора пар ключ-значение в формате JSON.
\nВы можете передать дополнительные параметры через это поле для настройки фильтров защиты от мошенничества. [Смотрите документацию Pay Station](https://developers.xsolla.com/ru/doc/pay-station/features/antifraud/).",
"type": [
"object",
"null"
],
"minProperties": 1,
"maxProperties": 200,
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"example": {
"custom_parameters": {
"string_param": "example",
"bool_param": true,
"int_param": 100,
"null_param": null
}
}
},
"Game-Keys_schemas-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"
}
}
}
}
}
}
},
"Game-Keys_admin-attributes": {
"type": "array",
"description": "Список атрибутов.",
"items": {
"$ref": "#/components/schemas/attribute"
}
},
"Game-Keys_regions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1
}
}
}
},
"Game-Keys_admin-post-put-attributes": {
"type": "array",
"maxItems": 20,
"description": "Список атрибутов.\n\nВнимание. Для товара невозможно указать более 20 атрибутов. Любые попытки превысить данное ограничение вызовут ошибку.
",
"items": {
"$ref": "#/components/schemas/admin-post-put-attribute-item"
}
},
"game_key_recurrent_schedule": {
"type": [
"object",
"null"
],
"description": "Период обновления установленный ограничений.",
"properties": {
"per_user": {
"oneOf": [
{
"$ref": "#/components/schemas/per_user_daily"
},
{
"$ref": "#/components/schemas/per_user_weekly"
},
{
"$ref": "#/components/schemas/per_user_monthly"
}
]
}
}
},
"Game-key-item-limit": {
"type": "object",
"description": "Ограничения на продажу товара.",
"properties": {
"per_user": {
"$ref": "#/components/schemas/limit_per_user"
},
"per_item": {
"$ref": "#/components/schemas/limit_per_item"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/game_key_recurrent_schedule"
}
}
},
"Game-Keys_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 `property_name` is required"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"Pagination_total-items-count": {
"type": "integer",
"example": 10,
"description": "Общее количество игр, которыми владеет пользователь."
},
"Game-Keys_client_name": {
"type": "string",
"example": "The Greatest Game in the World",
"description": "Название игрового пакета."
},
"Game-Keys_description": {
"type": "string",
"example": "Description of the greatest game in the world.",
"description": "Описание игрового пакета."
},
"Game-Keys_project_id": {
"type": "integer",
"example": 44056,
"description": "ID проекта. Вы можете найти этот параметр в [Личном кабинете](https://publisher.xsolla.com/) рядом с названием проекта."
},
"Game-Keys_game_sku": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9_\\-–.]*$",
"example": "theGreatestGameSku",
"description": "Уникальный ID пакета ключей."
},
"Game-Keys_drm_sku": {
"type": "string",
"example": "steam",
"description": "Уникальный ID платформы.",
"enum": [
"steam",
"playstation",
"xbox",
"uplay",
"origin",
"drmfree",
"gog",
"epicgames",
"nintendo_eshop",
"discord_game_store",
"oculus",
"rockstar",
"viveport",
"stadia"
]
},
"Game-Keys_image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "URL-адрес изображения. Для корректного отображения и быстрой загрузки изображения в платежном интерфейсе проверьте требования к файлу и ссылке:- Поддерживаемые форматы: WebP (рекомендуется), PNG, JPG.
- Размер файла: ≤ 50 КБ (для WebP) или ≤ 150 КБ (для PNG и JPG).
- Размер изображения: 280 x 280 px.
- Цветовое пространство: sRGB.
- Протокол передачи данных: HTTPS с долгосрочным кэшированием версионированных URL-адресов.
"
},
"Game-Keys_admin-attribute-external_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9-_]+$",
"example": "attribute_1",
"description": "Уникальный ID атрибута. `external_id` может содержать только строчные и заглавные латинские буквы, цифры, тире и подчеркивания."
},
"Game-Keys_value-external_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[-_.\\d\\w]+$",
"example": "attribute_value",
"description": "Уникальный ID значения атрибута. `external_id` может содержать только строчные латинские буквы, цифры, тире и подчеркивания."
},
"Game-Keys_client-attributes": {
"type": "array",
"description": "Список атрибутов и их значений, соответствующих игре.\n\nВнимание. Эта часть ответа доступна только при отправке параметра запроса `additional_fields[]=attributes`.
",
"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/Game-Keys_admin-attribute-external_id"
},
"name": {
"type": "string",
"description": "Название атрибута.",
"example": "Genre"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/Game-Keys_value-external_id"
},
"value": {
"type": "string",
"description": "Значение атрибута.",
"example": "Strategy"
}
}
}
}
}
}
},
"Game-Keys_entitlement_item": {
"type": "object",
"properties": {
"name": {
"$ref": "#/components/schemas/Game-Keys_client_name"
},
"description": {
"$ref": "#/components/schemas/Game-Keys_description"
},
"project_id": {
"$ref": "#/components/schemas/Game-Keys_project_id"
},
"game_sku": {
"$ref": "#/components/schemas/Game-Keys_game_sku"
},
"drm": {
"$ref": "#/components/schemas/Game-Keys_drm_sku"
},
"image_url": {
"$ref": "#/components/schemas/Game-Keys_image_url"
},
"is_pre_order": {
"type": "boolean",
"example": false,
"description": "Находится ли игра в статусе предзаказа."
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_client-attributes"
}
}
},
"Bundles_item_id": {
"type": "integer",
"example": 1,
"minLength": 1,
"maxLength": 255,
"description": "Внутренний уникальный ID виртуального предмета или валюты."
},
"Bundles_sku": {
"type": "string",
"example": "bundle_1",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9_\\-–.]*$",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"Bundles_admin-attributes": {
"type": "array",
"description": "Список атрибутов.",
"items": {
"$ref": "#/components/schemas/attribute"
}
},
"Bundles_type": {
"type": "string",
"example": "bundle",
"description": "Тип товара."
},
"bundle_type": {
"type": "string",
"description": "Тип бандла. Возвращается, если тип элемента является бандлом.",
"enum": [
"standard",
"virtual_currency_package",
"partner_side_content"
]
},
"Bundles_image_url": {
"type": [
"string",
"null"
],
"example": "https://image.example.com",
"description": "URL-адрес изображения. Для корректного отображения и быстрой загрузки изображения в платежном интерфейсе проверьте требования к файлу и ссылке:- Поддерживаемые форматы: WebP (рекомендуется), PNG, JPG.
- Размер файла: ≤ 50 КБ (для WebP) или ≤ 150 КБ (для PNG и JPG).
- Размер изображения: 280 x 280 px.
- Цветовое пространство: sRGB.
- Протокол передачи данных: HTTPS с долгосрочным кэшированием версионированных URL-адресов.
"
},
"Bundles_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"
}
}
}
}
},
"Bundles_amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "Цена товара.",
"pattern": "^\\d*\\.?\\d*$"
},
"Bundles_currency": {
"type": "string",
"example": "USD",
"description": "Валюта, в которой указана цена товара. Трехбуквенный код в соответствии со стандартом [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
},
"Bundles_prices": {
"type": "array",
"description": "Цены в реальных валютах.",
"items": {
"type": "object",
"properties": {
"amount": {
"$ref": "#/components/schemas/Bundles_amount_without_discount"
},
"currency": {
"$ref": "#/components/schemas/Bundles_currency"
},
"is_default": {
"type": "boolean",
"description": "Цена по умолчанию используется для построения каталога, если цена в валюте пользователя не указана."
},
"is_enabled": {
"type": "boolean",
"description": "Цена включена."
},
"country_iso": {
"type": [
"string",
"null"
],
"example": "US",
"description": "Страна, где доступна эта цена. Двухбуквенный код в соответствии с [ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)."
}
},
"required": [
"amount",
"currency",
"is_default",
"is_enabled"
]
}
},
"Bundles_vc-type": {
"type": "string",
"example": "virtual_currency",
"description": "Тип виртуальной валюты."
},
"Bundles_amount": {
"type": "string",
"example": "100.99",
"description": "Цена товара со скидкой.",
"pattern": "^\\d*\\.?\\d*$"
},
"Bundles_currency-is_default": {
"type": "boolean",
"example": true,
"description": "Является ли данная цена товара ценой по умолчанию."
},
"Bundles_admin-response-virtual_price": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"type": {
"$ref": "#/components/schemas/Bundles_vc-type"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Bundles_image_url"
},
"amount": {
"$ref": "#/components/schemas/Bundles_amount"
},
"is_default": {
"$ref": "#/components/schemas/Bundles_currency-is_default"
}
}
},
"Bundles_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": "Ссылка на файл."
}
}
}
},
"Bundles_order": {
"type": "integer",
"example": 1,
"default": 1,
"description": "Приоритет заказа бандла в списке."
},
"Bundles_is_enabled": {
"type": "boolean",
"example": true,
"default": true,
"description": "Если этот параметр отключен, товар не может быть найден и приобретен."
},
"Bundles_is_show_in_store": {
"type": "boolean",
"example": true,
"default": false,
"description": "Товар доступен для покупки."
},
"Bundles_admin-regions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1,
"example": 1
}
}
}
},
"Bundles_admin_content_response": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"type": {
"$ref": "#/components/schemas/Bundles_type"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Bundles_image_url"
},
"quantity": {
"type": "integer",
"description": "Количество единиц товара данного типа в бандле.",
"default": 1,
"minimum": 1
}
}
},
"Bundles_total_content_price": {
"type": [
"object",
"null"
],
"description": "Сумма цен содержимого бандла.",
"properties": {
"amount": {
"type": "string",
"example": "100.99",
"description": "Сумма цен содержимого бандла со скидкой."
},
"amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "Сумма цен содержимого бандла."
},
"currency": {
"$ref": "#/components/schemas/Bundles_currency"
}
}
},
"Bundles_admin_bundle_response": {
"type": "object",
"properties": {
"item_id": {
"$ref": "#/components/schemas/Bundles_item_id"
},
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"attributes": {
"$ref": "#/components/schemas/Bundles_admin-attributes"
},
"type": {
"$ref": "#/components/schemas/Bundles_type"
},
"bundle_type": {
"$ref": "#/components/schemas/bundle_type"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Bundles_image_url"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"groups": {
"$ref": "#/components/schemas/Bundles_groups_response"
},
"prices": {
"$ref": "#/components/schemas/Bundles_prices"
},
"virtual_prices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bundles_admin-response-virtual_price"
}
},
"media_list": {
"anyOf": [
{
"$ref": "#/components/schemas/Bundles_media_list"
},
{
"type": "null"
}
]
},
"order": {
"$ref": "#/components/schemas/Bundles_order"
},
"is_enabled": {
"$ref": "#/components/schemas/Bundles_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Bundles_is_show_in_store"
},
"regions": {
"$ref": "#/components/schemas/Bundles_admin-regions"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bundles_admin_content_response"
}
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"total_content_price": {
"$ref": "#/components/schemas/Bundles_total_content_price"
}
},
"description": "Указанный бандл."
},
"Bundles_groups_request": {
"type": "array",
"example": [
"honor"
],
"default": [],
"description": "Группы, к которым принадлежит товар.\n\nПримечание. Строковое значение относится к группе `external_id`.
",
"items": {
"type": "string"
}
},
"Bundles_admin-post-put-attributes": {
"type": "array",
"maxItems": 20,
"description": "Список атрибутов.\n\nВнимание. Для товара невозможно указать более 20 атрибутов. Любые попытки превысить данное ограничение вызовут ошибку.
",
"items": {
"$ref": "#/components/schemas/admin-post-put-attribute-item"
}
},
"Bundles_vc_prices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "gold",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"amount": {
"type": "integer"
},
"is_default": {
"type": "boolean"
},
"is_enabled": {
"type": "boolean"
}
},
"required": [
"amount",
"currency",
"is_default",
"is_enabled"
]
}
},
"Bundles_bundle_type": {
"type": "string",
"example": "standard",
"enum": [
"standard",
"partner_side_content"
],
"description": "Тип бандла. Используйте `standard`, чтобы создать бандл с товарами и указать артикулы товаров, которые содержатся в бандле.\nИспользуйте `partner_side_content`, чтобы создать пустой бандл и добавить в него товары на своей стороне с помощью [вебхука](https://developers.xsolla.com/ru/webhooks/operation/personalized-partner-catalog/). Используется только для [персонализации каталога товаров на стороне партнера](https://developers.xsolla.com/ru/doc/shop-builder/features/personalization/#guides_personalization_on_partner_side).",
"default": "standard"
},
"Bundles_admin_content_request": {
"type": "array",
"minItems": 1,
"description": "Массив товаров, входящих в состав бандла. Товары должны быть созданы в проекте заранее. Если указанный артикул не существует, система вернет ошибку.",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9_\\-–.]*$",
"example": "com.xsolla.kg_1",
"description": "Артикул товара, который входит в состав бандла. Товар должен уже существовать в каталоге проекта. Если указанный артикул не существует, система вернет ошибку. Допустимые символы: a–z, A–Z, 0–9, точка (.), дефис (-), подчеркивание (_)."
},
"quantity": {
"type": "integer",
"description": "Количество выбранных товаров в бандле.",
"default": 1,
"minimum": 1
}
},
"required": [
"sku"
],
"example": {
"sku": "com.xsolla.kg_1",
"quantity": 1
}
}
},
"per_user_hourly_bundle": {
"type": "object",
"title": "interval_type = hourly",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/interval_type_hourly"
},
"hours_interval": {
"allOf": [
{
"$ref": "#/components/schemas/hours_interval"
},
{
"description": "Интервал в часах, через который обновляется лимит покупок товара.
Отсчет начинается с момента, когда товар впервые отображается в магазине — задается в параметре date_from.
Например, если `date_start = \"2025-11-15T18:15:00+05:00\"` и `hours_interval = 2`, лимит покупок для этого товара будет обновляться каждые 2 часа, начиная с `\"2025-11-15T20:15:00+05:00\"`."
}
]
}
},
"required": [
"interval_type",
"hours_interval"
]
},
"bundle_recurrent_schedule": {
"type": [
"object",
"null"
],
"description": "Период обновления установленный ограничений.",
"properties": {
"per_user": {
"description": "Сброс лимитов на покупку товара, выполняемый через временной интервал, заданный в часах.",
"oneOf": [
{
"$ref": "#/components/schemas/per_user_daily"
},
{
"$ref": "#/components/schemas/per_user_weekly"
},
{
"$ref": "#/components/schemas/per_user_monthly"
},
{
"$ref": "#/components/schemas/per_user_hourly_bundle"
}
]
}
}
},
"bundle-item-limit": {
"type": "object",
"description": "Ограничения на продажу товара.",
"properties": {
"per_user": {
"$ref": "#/components/schemas/limit_per_user"
},
"per_item": {
"$ref": "#/components/schemas/limit_per_item"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/bundle_recurrent_schedule"
}
}
},
"Bundles_admin_bundle_request": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"groups": {
"$ref": "#/components/schemas/Bundles_groups_request"
},
"attributes": {
"$ref": "#/components/schemas/Bundles_admin-post-put-attributes"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Bundles_image_url"
},
"prices": {
"$ref": "#/components/schemas/Bundles_prices"
},
"vc_prices": {
"anyOf": [
{
"$ref": "#/components/schemas/Bundles_vc_prices"
},
{
"type": "null"
}
]
},
"bundle_type": {
"$ref": "#/components/schemas/Bundles_bundle_type"
},
"content": {
"$ref": "#/components/schemas/Bundles_admin_content_request"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"is_enabled": {
"$ref": "#/components/schemas/Bundles_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Bundles_is_show_in_store"
},
"media_list": {
"anyOf": [
{
"$ref": "#/components/schemas/Bundles_media_list"
},
{
"type": "null"
}
]
},
"order": {
"$ref": "#/components/schemas/Bundles_order"
},
"regions": {
"$ref": "#/components/schemas/Bundles_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/bundle-item-limit"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes"
}
},
"description": "Указанный бандл.",
"required": [
"sku",
"name",
"description"
]
},
"Bundles_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 `property_name` is required"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
},
"errorMessageExtended": {
"type": "array"
}
}
},
"Bundles_client_name": {
"type": "string",
"example": "Big Rocket",
"description": "Название товара."
},
"Bundles_client_description": {
"type": [
"string",
"null"
],
"example": "Big Rocket - description.",
"description": "Описание товара."
},
"Bundles_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"
}
}
}
}
}
}
},
"Bundles_price": {
"type": [
"object",
"null"
],
"description": "Цена товара.",
"required": [
"amount",
"amount_without_discount",
"currency"
],
"properties": {
"amount": {
"$ref": "#/components/schemas/Bundles_amount"
},
"amount_without_discount": {
"$ref": "#/components/schemas/Bundles_amount_without_discount"
},
"currency": {
"$ref": "#/components/schemas/Bundles_currency"
}
}
},
"Catalog_item_limits_with_hourly": {
"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"
]
},
"Bundles_client_content": {
"type": "array",
"example": [
{
"description": "Big Rocket - short description.",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"type": "virtual_currency",
"quantity": 100,
"attributes": [],
"is_free": false,
"groups": [],
"price": {
"amount": "10.99",
"currency": "USD",
"amount_without_discount": "10.99"
}
}
],
"description": "Содержимое бандла.",
"items": {
"type": "object",
"description": "Товар в пакете.",
"properties": {
"sku": {
"type": "string",
"example": "com.xsolla.big_rocket_1",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"name": {
"type": "string",
"example": "Big Rocket",
"description": "Название товара."
},
"type": {
"type": "string",
"example": "virtual_currency",
"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-адрес изображения."
},
"quantity": {
"type": "integer",
"example": 250,
"description": "Количество товара в пакете."
},
"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"
]
},
"attributes": {
"$ref": "#/components/schemas/Bundles_client-attributes"
},
"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). Подробную информацию о [валютах, поддерживаемых Xsolla, смотрите в документации](https://developers.xsolla.com/ru/doc/pay-station/references/supported-currencies/)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits_with_hourly"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"groups": {
"$ref": "#/components/schemas/Bundles_groups_response"
}
}
}
},
"Bundles_client_bundle": {
"type": "object",
"properties": {
"item_id": {
"$ref": "#/components/schemas/Bundles_item_id"
},
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
},
"name": {
"$ref": "#/components/schemas/Bundles_client_name"
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"description": {
"$ref": "#/components/schemas/Bundles_client_description"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"attributes": {
"$ref": "#/components/schemas/Bundles_client-attributes"
},
"type": {
"$ref": "#/components/schemas/Bundles_type"
},
"bundle_type": {
"$ref": "#/components/schemas/Bundles_bundle_type"
},
"image_url": {
"$ref": "#/components/schemas/Bundles_image_url"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"$ref": "#/components/schemas/Bundles_price"
},
"total_content_price": {
"$ref": "#/components/schemas/Bundles_total_content_price"
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"content": {
"$ref": "#/components/schemas/Bundles_client_content"
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits_with_hourly"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
},
"loyalty_rewards": {
"$ref": "#/components/schemas/item-loyalty-point-reward"
},
"loyalty_prices": {
"$ref": "#/components/schemas/item-loyalty-point-prices"
},
"order": {
"$ref": "#/components/schemas/Bundles_order"
},
"media_list": {
"$ref": "#/components/schemas/Bundles_media_list"
}
},
"description": "Указанный бандл."
},
"value-cart_is_free": {
"type": "boolean",
"example": false,
"default": false,
"description": "Если `true`, корзина бесплатная."
},
"Cart-Payment_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"
}
}
}
}
}
}
},
"Catalog_cart_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"
}
}
}
}
}
}
}
},
"Cart-Payment_settings_ui": {
"description": "Объект с настройками интерфейса.",
"type": "object",
"additionalProperties": false,
"properties": {
"theme": {
"description": "Тема платежного интерфейса. Может принимать значения `63295a9a2e47fab76f7708e1` для светлой темы (по умолчанию) или `63295aab2e47fab76f7708e3` для темной темы. Вы также можете [создать собственную тему](https://developers.xsolla.com/ru/doc/pay-station/features/ui-theme-customization/#pay_station_ui_theme_customization_in_token) и передать ID темы в этом параметре.",
"type": "string",
"default": "63295a9a2e47fab76f7708e1",
"enum": [
"63295a9a2e47fab76f7708e1",
"63295aab2e47fab76f7708e3"
]
},
"desktop": {
"type": "object",
"additionalProperties": false,
"description": "Объект с настройками интерфейса для настольной версии.",
"properties": {
"header": {
"type": "object",
"additionalProperties": false,
"description": "Объект с настройками хедера.",
"properties": {
"is_visible": {
"type": "boolean",
"description": "Показывать ли хедер в платежном интерфейсе."
},
"visible_logo": {
"type": "boolean",
"description": "Если `true`, логотип будет отображаться в хедере. Чтобы загрузить изображение, откройте свой проект в [Личном кабинете](https://publisher.xsolla.com/) и перейдите в раздел Pay Station > Настройки."
},
"visible_name": {
"type": "boolean",
"description": "Показывать ли в хедере название проекта."
},
"visible_purchase": {
"type": "boolean",
"description": "Показывать ли в хедере описание покупки (`purchase.description.value`). По умолчанию `true`.",
"default": true
},
"type": {
"type": "string",
"description": "Внешний вид хедера. Может принимать значения `compact` (в хедере не будут показываться название игры и ID пользователя) или `normal`.",
"default": "normal",
"enum": [
"compact",
"normal"
]
},
"close_button": {
"type": "boolean",
"description": "Показывать ли кнопку **Закрыть** в платежном интерфейсе. Нажатие на кнопку закрывает платежный интерфейс и перенаправляет пользователя на адрес, указанный в параметре `settings.return_url`. `false` по умолчанию.",
"default": false
}
}
}
}
},
"mode": {
"type": "string",
"enum": [
"user_account"
],
"description": "Платежный интерфейс в режиме Личного кабинета. Принимает значение `user_account`. Header содержит только навигационное меню Личного кабинета; исключается возможность выбора предмета и оплата покупки; режим Личного кабинета доступен только в desktop-режиме."
},
"user_account": {
"type": "object",
"additionalProperties": false,
"description": "Объект с данными об учетной записи пользователя.",
"properties": {
"payment_accounts": {
"type": "object",
"additionalProperties": false,
"description": "Страница **Сохраненные платежные аккаунты**.",
"properties": {
"enable": {
"type": "boolean",
"default": false,
"description": "Показывать ли вкладку в меню. По умолчанию `false`."
}
},
"required": [
"enable"
]
},
"info": {
"type": "object",
"additionalProperties": false,
"description": "Страница **Мой аккаунт**.",
"properties": {
"enable": {
"type": "boolean",
"default": false,
"description": "Показывать ли вкладку в меню. По умолчанию `false`."
},
"order": {
"type": "integer",
"minimum": 1,
"description": "Расположение раздела в раскрывающемся меню в платежном интерфейсе."
}
},
"required": [
"enable",
"order"
]
},
"subscriptions": {
"type": "object",
"additionalProperties": false,
"description": "Страница **Управление подписками**.",
"properties": {
"enable": {
"type": "boolean",
"default": false,
"description": "Показывать ли вкладку в меню. По умолчанию `false`."
},
"order": {
"type": "integer",
"minimum": 1,
"description": "Расположение раздела в раскрывающемся меню в платежном интерфейсе."
}
},
"required": [
"enable",
"order"
]
}
}
},
"header": {
"type": "object",
"properties": {
"visible_virtual_currency_balance": {
"type": "boolean",
"additionalProperties": false,
"description": "Должен ли этот элемент быть видимым в интерфейсе оплаты.",
"default": true
}
}
},
"mobile": {
"type": "object",
"properties": {
"header": {
"type": "object",
"additionalProperties": false,
"properties": {
"close_button": {
"type": "boolean",
"description": "Показывать ли кнопку **Закрыть** в платежном интерфейсе. Нажатие на кнопку закрывает платежный интерфейс и перенаправляет пользователя на адрес, указанный в параметре `settings.return_url`.",
"default": false
}
}
}
}
},
"is_prevent_external_link_open": {
"type": "boolean",
"description": "Отключение перехода по внешним ссылкам. При нажатии на внешнюю ссылку отправляется событие `external-link-open` с помощью механизма `postMessage`. В параметре `url` передается адрес, по которому выполняется переход.",
"default": false
},
"is_payment_methods_list_mode": {
"type": "boolean",
"description": "Отображается ли список способов оплаты, доступных в стране игрока, при открытии платежного интерфейса. Если передано значение `false` (по умолчанию), отображается способ оплаты, переданный в параметре `settings.payment_method` или способ, выбранный [алгоритмом PayRank](https://developers.xsolla.com/ru/solutions/payments/payment-ui-management/top-payment-methods-management/).",
"default": false
},
"is_independent_windows": {
"type": "boolean",
"description": "Осуществляется ли переход из встроенного браузера лаунчера (WebView) во внешний браузер для совершения покупки.",
"default": false
},
"currency_format": {
"type": "string",
"description": "Передайте значение `code`, чтобы в платежном интерфейсе отображалось трехбуквенное обозначение валюты по [ISO 4217](https://developers.xsolla.com/ru/doc/pay-station/references/supported-currencies/). По умолчанию вместо трехбуквенного обозначения валюты отображается значок валюты."
},
"is_show_close_widget_warning": {
"type": "boolean",
"description": "Показывать ли предупреждение об обработке транзакции при наведении на значок **×** перед закрытием страницы оплаты. Если передано значение `false` или параметр не передан, предупреждение не показывается.",
"default": true
},
"layout": {
"type": "string",
"description": "Расположение основных элементов платежного интерфейса. Вы можете открыть платежный интерфейс внутри вашей игры и/или поменять местами колонки с информацией о заказе и способах оплаты. Подробная информация представлена в [инструкции по кастомизации](https://developers.xsolla.com/ru/doc/pay-station/features/ui-theme-customization/#pay_station_ui_theme_customization_layout).",
"enum": [
"embed",
"column_reverse",
"embed_column_reverse"
]
},
"is_three_ds_independent_windows": {
"type": "boolean",
"description": "Откроется ли проверка 3-D Secure в новом окне браузера. Если в вашей программе настройки применяется политика безопасности содержимого (CSP), установите значение `true`.",
"default": false
},
"is_cart_open_by_default": {
"type": "boolean",
"description": "Отображение списка товаров в корзине при открытии мобильной версии платежного интерфейса. Если передано значение `true`, список отображается в развернутом виде. Если передано значение `false` (по умолчанию) или параметр не передан — список отображается в свернутом виде.",
"default": false
}
}
},
"Cart-Payment_settings_payment_method": {
"type": "integer",
"description": "ID платежного метода. Влияет на отображение валюты в платежном интерфейсе, так как некоторые платежные методы могут поддерживать только определенные валюты.",
"minimum": 1
},
"Cart-Payment_settings_return_url": {
"type": "string",
"format": "uri",
"description": "Пользователь будет перенаправлен на данную страницу после совершения платежа. Параметры `user_id`, `foreigninvoice`, `invoice_id` и `status` будут автоматически добавлены к ссылке.",
"maxLength": 1000
},
"Cart-Payment_redirect_policy": {
"type": "object",
"properties": {
"redirect_conditions": {
"description": "Статус платежа, при котором происходит перенаправление пользователя на return URL.",
"type": "string",
"example": "none",
"enum": [
"none",
"successful",
"successful_or_canceled",
"any"
]
},
"delay": {
"description": "Задержка, по истечении которой пользователь будет автоматически перенаправлен на return URL.",
"type": "integer",
"example": 0
},
"status_for_manual_redirection": {
"description": "Статус платежа, при котором появляется кнопка для возврата на return URL.",
"type": "string",
"example": "none",
"enum": [
"none",
"successful",
"successful_or_canceled",
"any"
]
},
"redirect_button_caption": {
"description": "Локализованные надписи на кнопке редиректа.",
"type": "string",
"example": "Text button"
}
}
},
"Cart-Payment_settings_sandbox": {
"type": "boolean",
"description": "Передайте значение `true`, чтобы провести тестовые платежи. Обратите внимание, что URL для страницы оплаты будет https://sandbox-secure.xsolla.com.",
"default": false
},
"Cart-Payment_admin-user-request-body": {
"type": "object",
"required": [
"id"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "object",
"properties": {
"value": {
"description": "ID пользователя. При тестировании вы можете передать в параметре любые символы. Для приема реальных платежей передайте в параметре ID пользователя из вашей системы. Этот ID будет передаваться в вебхуке [](https://developers.xsolla.com/ru/webhooks/operation/user-validation/).",
"type": "string",
"minLength": 1,
"maxLength": 255
}
}
},
"name": {
"type": "object",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Никнейм пользователя."
}
}
},
"email": {
"type": "object",
"properties": {
"value": {
"type": "string",
"minLength": 3,
"maxLength": 255,
"format": "email",
"description": "Email-адрес пользователя. Должен быть валидным в соответствии с протоколом RFC 822."
}
}
},
"country": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Двухбуквенный код страны в верхнем регистре согласно стандарту [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Параметр обязательный, если в заголовке `X-User-Ip`не передан IP-адрес. Список стран, поддерживаемых Xsolla, приведен [в документации](https://developers.xsolla.com/ru/doc/shop-builder/references/supported-countries/).
Пример: `country=US`",
"example": "US"
},
"allow_modify": {
"type": "boolean",
"description": "Может ли пользователь изменить страну в платежном интерфейсе.",
"default": false,
"example": false
}
}
},
"age": {
"type": "integer",
"description": "Возраст пользователя."
},
"phone": {
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"description": "Номер телефона пользователя."
},
"allow_modify": {
"type": "boolean",
"description": "Может ли пользователь изменить номер телефона в пользовательском интерфейсе оплаты. Если `phone.value` передается в токене, по умолчанию значение равно `false`.",
"default": false,
"example": false
},
"hidden": {
"type": "boolean",
"default": true,
"example": false
}
}
},
"tracking_id": {
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"minLength": 32,
"maxLength": 32,
"pattern": "^[A-Za-z0-9]{32}$",
"description": "Уникальный идентификатор отслеживания (используется в маркетинговых кампаниях)."
}
}
},
"steam_id": {
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"minLength": 17,
"maxLength": 17,
"pattern": "^\\d{17}$",
"description": "Steam ID."
}
}
},
"is_legal": {
"type": "boolean",
"description": "Является ли пользователь юридическим лицом."
},
"legal": {
"type": "object",
"description": "Объект с реквизитами юридического лица. Объект и все его параметры обязательны, если `user.is_legal` имеет значение `true`.",
"properties": {
"name": {
"type": "string",
"description": "Полное юридическое наименование."
},
"address": {
"type": "string",
"description": "Полный юридический адрес."
},
"vat_id": {
"type": "string",
"description": "Индивидуальный идентификатор налогоплательщика."
},
"country": {
"type": "string",
"description": "Страна регистрации. Используется двухбуквенный код страны в верхнем регистре согласно [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)."
}
}
}
}
},
"Cart_admin_payment": {
"type": "object",
"additionalProperties": false,
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"minLength": 1,
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания.\n\nВнимание
Если вы хотите продать несколько единиц одного товара, передайте необходимое количество в параметре purchase.items[].quantity. Дублирование артикулов в массиве не поддерживается — при создании токена будет учтен только первый переданный объект. Ошибка при этом не возвращается.
",
"example": "t-shirt"
},
"quantity": {
"type": "number",
"minimum": 1,
"example": 2,
"description": "Количество товара."
}
},
"required": [
"sku",
"quantity"
]
},
"minItems": 1
}
},
"required": [
"items"
]
},
"Promotions_coupon_code": {
"type": "string",
"description": "Уникальный код, чувствительный к регистру. Содержит буквы и цифры.",
"minLength": 1,
"maxLength": 128,
"example": "WINTER2021",
"default": "WINTER2021",
"pattern": "^[a-zA-Z0-9]+$"
},
"Cart-Payment_settings_currency": {
"type": "string",
"description": "Предпочитаемая валюта платежа. Трехбуквенный код валюты в соответствии с [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Список валют, поддерживаемых Xsolla, [приведен в документации](https://developers.xsolla.com/ru/doc/pay-station/references/supported-currencies/)."
},
"Cart-Payment_settings_locale": {
"type": "string",
"description": "Язык интерфейса. Двухбуквенный [код языка](https://developers.xsolla.com/ru/doc/pay-station/features/localization/) в нижнем регистре."
},
"Cart-Payment_settings_external_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "External ID транзакции."
},
"Cart-Payment_custom_parameters_token": {
"description": "Ваши пользовательские параметры представлены в виде допустимого набора пар ключ-значение в формате JSON.
\nВы можете передать дополнительные параметры через это поле для настройки фильтров защиты от мошенничества. [Смотрите документацию Pay Station](https://developers.xsolla.com/ru/doc/pay-station/features/antifraud/).",
"type": [
"object",
"null"
],
"minProperties": 1,
"maxProperties": 200,
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"example": {
"custom_parameters": {
"string_param": "example",
"bool_param": true,
"int_param": 100,
"number_param": 12.5,
"null_param": null
}
}
},
"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"
}
}
},
"Cart": {
"type": "object",
"additionalProperties": false,
"properties": {
"country": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"example": "US",
"description": "Двухбуквенное обозначение страны в верхнем регистре согласно стандарту [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Список стран, поддерживаемых Xsolla, [приведен в документации](https://developers.xsolla.com/ru/doc/shop-builder/references/supported-countries/).
Пример: `country=US`"
},
"currency": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"example": "USD",
"description": "Валюта, в которой указаны цены товаров в корзине. Трехбуквенный код в соответствии с [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Подробную информацию о [валютах, поддерживаемых Xsolla, смотрите в документации](https://developers.xsolla.com/ru/doc/pay-station/references/supported-currencies/)."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"minLength": 1,
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания.",
"example": "t-shirt"
},
"quantity": {
"type": "number",
"minimum": 1,
"example": 2,
"description": "Количество товара."
}
},
"required": [
"sku",
"quantity"
]
},
"minItems": 1
}
},
"required": [
"items"
]
},
"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-item": {
"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": "Оставшееся количество товаров для продажи или доступных акций для пользователя в пределах установленных ограничений."
},
"422-invalid-request-extended": {
"type": "object",
"properties": {
"statusCode": {
"type": "number",
"description": "Код статуса ответа.",
"example": 422
},
"errorCode": {
"type": "number",
"description": "Код ошибки.",
"example": 1102
},
"errorMessage": {
"type": "string",
"description": "Удобочитаемое сообщение об ошибке.",
"example": "[0401-1102]: Unprocessable Entity"
},
"errorMessageExtended": {
"$ref": "#/components/schemas/error-message-extended-validation"
},
"transactionId": {
"type": "string",
"description": "ID запроса. Может использоваться для обращения в службу поддержки Xsolla.",
"example": "da145238620011eb8e24fe6913ff226a"
}
}
},
"client_virtual_prices_with_calculated_price_response": {
"type": "array",
"description": "Виртуальные цены.",
"items": {
"type": "object",
"description": "Виртуальная цена.",
"properties": {
"amount": {
"type": "integer",
"example": 100,
"description": "Цена товара в виртуальной валюте."
},
"amount_without_discount": {
"type": "integer",
"example": 200,
"description": "Цена товара в виртуальной валюте без скидки. Всегда равна значению `amount`, так как скидки не применяются к ценам в виртуальной валюте."
},
"calculated_price": {
"type": "object",
"properties": {
"amount": {
"type": "string"
},
"amount_without_discount": {
"type": "string"
}
}
},
"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-адрес изображения виртуальной валюты."
},
"item_id": {
"type": "integer",
"example": 259774,
"description": "Уникальный ID товара, назначенный Xsolla."
},
"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": "Описание виртуальной валюты."
}
}
}
},
"Regions_region_id": {
"type": "integer",
"description": "ID региона. Уникальный идентификатор региона в рамках проекта.",
"example": 42
},
"Regions_name": {
"type": "object",
"description": "Название региона. Данный параметр должен содержать пары ключ/значение, где ключ — это локаль в формате \"^[a-z]{2}-[A-Z]{2}$\", значение — строка.",
"additionalProperties": {
"type": "string"
},
"example": {
"en-US": "Asia",
"de-DE": "Asien"
},
"default": {
"en-US": "Asia",
"de-DE": "Asien"
}
},
"Regions_200-region-short-model": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/Regions_region_id"
},
"name": {
"$ref": "#/components/schemas/Regions_name"
}
}
},
"Regions_countries": {
"type": "array",
"description": "Список стран, которые необходимо добавить в регион.\n
Двухбуквенное обозначение страны в верхнем регистре согласно стандарту [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).\nСписок стран, поддерживаемых Xsolla, приведен [в документации](https://developers.xsolla.com/ru/doc/shop-builder/references/supported-countries/).\n
Пример: `[\"JP\", \"CN\", \"VN\"]`",
"items": {
"type": "string"
}
},
"Regions_200-region-model": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/Regions_region_id"
},
"name": {
"$ref": "#/components/schemas/Regions_name"
},
"countries": {
"$ref": "#/components/schemas/Regions_countries"
}
},
"example": {
"value": {
"id": 44,
"name": {
"en-US": "Asia",
"de-DE": "Asien"
},
"countries": [
"JP",
"CN",
"VN"
]
}
}
},
"admin_attribute_response": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"$ref": "#/components/schemas/admin-attribute-name"
}
},
"example": {
"value": [
{
"external_id": "genre",
"name": {
"en": "Genre",
"de": "Genre"
}
}
]
}
},
"schemas-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 `property_name` is required"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"request-attribute-value": {
"type": "object",
"required": [
"external_id",
"value"
],
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
},
"value": {
"$ref": "#/components/schemas/value-name"
}
},
"example": {
"external_id": "value_id",
"value": {
"en": "Value",
"de": "Wert"
}
}
},
"404-not-found": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0000-0000]: Entity not found"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
},
"responses": {
"Virtual-Items-Currency_200-admin-get-virtual-items": {
"description": "Список виртуальных предметов успешно получен.",
"content": {
"application/json": {
"example": {
"items": [
{
"sku": "com.xsolla.armor_max_1",
"name": {
"en": "Maximum Armor Xsolla Skin"
},
"type": "virtual_good",
"description": {
"en": "Suit up with flair showcasing your allegiance to Xsolla"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"long_description": {
"en": "The metal coverings formerly worn by soldiers or warriors to protect the body in battle."
},
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "featured",
"name": {
"en": "featured"
}
},
{
"external_id": "Xsolla",
"name": {
"en": "Xsolla"
}
},
{
"external_id": "Premium",
"name": {
"en": "Premium"
}
},
{
"external_id": "NonConsumableGroupCode",
"name": {
"en": "Non-consumable"
}
}
],
"prices": [
{
"amount": 12.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"country_iso": "CZ",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
{
"sku": "com.xsolla.armor_max_2",
"name": {
"en": "Empire Maximum Armor"
},
"type": "virtual_good",
"description": {
"en": "A strong armor forged to withstand heavy attacks."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/67d647ad4f4e9a905bd552b0408db8a8.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
},
{
"external_id": "equipment",
"name": {
"en": "Nice Equipment"
}
},
{
"external_id": "Empire",
"name": {
"en": "Empire"
}
}
],
"prices": [
{
"amount": 12.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"country_iso": "CZ",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"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"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.armor_med_1",
"name": {
"en": "Xsolla Medium Armor"
},
"type": "virtual_good",
"description": {
"en": "Moderately protect yourself against the Empires barrage of attacks"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/7f6e216f8fcc3c1796162897c2b0db01.png",
"long_description": {
"en": "Armor is a security-as-a-service company that provides cloud security and compliance solutions for small businesses and enterprises."
},
"attributes": [],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
},
{
"external_id": "Xsolla",
"name": {
"en": "Xsolla"
}
},
{
"external_id": "equipment",
"name": {
"en": "Nice Equipment"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"country_iso": "CZ",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": false,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"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"
}
}
},
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.armor_med_2",
"name": {
"en": "Empire Medium Armor"
},
"type": "virtual_good",
"description": {
"en": "Provides moderate protection in battle."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png",
"long_description": {
"en": "A strong armor forged to withstand heavy attacks."
},
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
},
{
"external_id": "equipment",
"name": {
"en": "Nice Equipment"
}
},
{
"external_id": "Empire",
"name": {
"en": "Empire"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"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"
}
}
},
"periods": []
},
{
"sku": "com.xsolla.armor_large_3",
"name": {
"en": "Empire Large Armor"
},
"type": "virtual_good",
"description": {
"en": "Provides moderate protection in battle."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
},
{
"external_id": "equipment",
"name": {
"en": "Nice Equipment"
}
},
{
"external_id": "Empire",
"name": {
"en": "Empire"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {
"per_user": {
"interval_type": "hourly",
"hours_interval": 8,
"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"
}
}
},
"periods": []
}
]
},
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-item"
}
}
}
}
}
}
},
"Virtual-Items-Currency_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"
}
}
}
}
}
},
"Virtual-Items-Currency_201-created": {
"description": "Виртуальный предмет успешно создан.",
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"sku": "com.xsolla.item_1"
}
}
},
"schema": {
"type": "object",
"example": {
"sku": "com.xsolla.item_1"
},
"properties": {
"sku": {
"type": "string",
"example": "new-sku"
}
}
}
}
}
},
"Virtual-Items-Currency_422-invalid-request": {
"description": "Неверный запрос.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_422-invalid-request"
},
"examples": {
"The property `sku` is required": {
"$ref": "#/components/examples/422-property-sku-is-required"
},
"Numbers of attribute values per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attribute-values-per-item-exceeded"
},
"Numbers of attributes per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attributes-per-item-exceeded"
},
"Value limit exceeded": {
"$ref": "#/components/examples/422-value-limit-exceeded"
},
"Custom attributes JSON can’t exceed 500 characters": {
"$ref": "#/components/examples/422-custom-attributes-size-exceeded"
}
}
}
}
},
"Virtual-Items-Currency_200-admin-get-virtual-items-by-group": {
"description": "Список виртуальных предметов успешно получен.",
"content": {
"application/json": {
"example": {
"items": [
{
"sku": "com.xsolla.armor_max_2",
"name": {
"en": "Empire Maximum Armor"
},
"type": "virtual_good",
"description": {
"en": "A strong armor forged to withstand heavy attacks"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/67d647ad4f4e9a905bd552b0408db8a8.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
},
{
"external_id": "accessory",
"name": {
"en": "Accessory"
}
}
],
"prices": [
{
"amount": 12.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"country_iso": "CZ",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "monthly",
"day_of_week": null,
"day_of_month": 28,
"time": "11:00:00+08:00",
"reset_next_date": 1679972400,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-03-28T11:00:00+08:00"
}
}
},
"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"
}
},
{
"sku": "com.xsolla.armor_med_1",
"name": {
"en": "Xsolla Medium Armor"
},
"type": "virtual_good",
"description": {
"en": "Moderately protect yourself against the Empires barrage of attacks"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/7f6e216f8fcc3c1796162897c2b0db01.png",
"long_description": {
"en": "Armor is a security-as-a-service company that provides cloud security and compliance solutions for small businesses and enterprises."
},
"attributes": [],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
},
{
"external_id": "accessory",
"name": {
"en": "Accessory"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"country_iso": "CZ",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": false,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"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"
}
}
},
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.armor_med_2",
"name": {
"en": "Empire Medium Armor"
},
"type": "virtual_good",
"description": {
"en": "Provides moderate protection in battle."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png",
"long_description": {
"en": "A strong armor forged to withstand heavy attacks."
},
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
},
{
"external_id": "accessory",
"name": {
"en": "Accessory"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"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"
}
}
},
"periods": []
},
{
"sku": "com.xsolla.armor_lrg_2",
"name": {
"en": "Empire Large Armor"
},
"type": "virtual_good",
"description": {
"en": "Provides moderate protection in battle."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png",
"long_description": {
"en": "A strong armor forged to withstand heavy attacks."
},
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
},
{
"external_id": "accessory",
"name": {
"en": "Accessory"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {
"per_user": {
"interval_type": "hourly",
"hours_interval": 8,
"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"
}
}
},
"periods": []
}
]
},
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-item"
}
}
}
}
}
}
},
"Virtual-Items-Currency_200-admin-get-item": {
"description": "Указанный виртуальный предмет успешно получен.",
"content": {
"application/json": {
"example": {
"sku": "com.xsolla.swords_1",
"name": {
"en": "Sword Xsolla Skin"
},
"type": "virtual_good",
"description": {
"en": "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/8ab44fe99038a56de01950ba4a971b77.png",
"long_description": {
"en": "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"
},
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"is_paid_randomized_reward": true,
"order": 1,
"groups": [
{
"external_id": "accessory",
"name": {
"en": "accessory"
}
},
{
"external_id": "weapon",
"name": {
"en": "weapon"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"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"
}
}
},
"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"
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-item"
}
}
}
},
"Virtual-Items-Currency_200-admin-get-virtual-currencies": {
"description": "Список виртуальных валют успешно получен.",
"content": {
"application/json": {
"example": {
"items": [
{
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 1,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"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"
}
}
},
"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"
}
},
{
"sku": "com.xsolla.gold_1",
"name": {
"en": "Gold",
"ru": "Gold"
},
"type": "virtual_currency",
"description": {
"en": "Money for in-store purchases"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 1,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
}
]
},
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency"
}
}
}
}
}
}
},
"Virtual-Items-Currency_200-admin-get-virtual-currency": {
"description": "Указанная виртуальная валюта успешно получена.",
"content": {
"application/json": {
"example": {
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"is_paid_randomized_reward": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 1,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency"
}
}
}
},
"Virtual-Items-Currency_404-item": {
"description": "Товар не найден. Убедитесь, что верно указали `project_id` и `item_sku`.",
"content": {
"application/json": {
"schema": {
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_12222 not found"
}
},
"type": "object"
}
}
}
},
"Virtual-Items-Currency_200-admin-get-virtual-currency-packages": {
"description": "Список пакетов виртуальной валюты успешно получен.",
"content": {
"application/json": {
"example": {
"items": [
{
"sku": "com.xsolla.crystal_pack_1",
"name": {
"en": "Small crystal pack"
},
"type": "bundle",
"description": {
"en": "Crystals x100"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/a8682cea328afda0bd127d59eb5b9077.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 5,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"quantity": 100
}
],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"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"
}
}
},
"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"
}
},
{
"sku": "com.xsolla.crystal_pack_2",
"name": {
"en": "Medium crystal pack"
},
"type": "bundle",
"description": {
"en": "Crystals x500"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/431a40dd8c99290dd761508964ddbacf.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 20,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "com.xsolla.crystal_2",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"quantity": 500
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.crystal_pack_3",
"name": {
"en": "Massive crystal pack"
},
"type": "bundle",
"description": {
"en": "Crystals x1500"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/1d67a1d2f92d69e021a97effa692dff3.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 50,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "com.xsolla.crystal_3",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"quantity": 1500
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
},
{
"sku": "com.xsolla.gold_pack_1",
"name": {
"en": "Small gold pack"
},
"type": "bundle",
"description": {
"en": "Gold x100"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/09984ff0a3ae6b367c9c886b31366950.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 5,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Money for in-store purchases"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png",
"sku": "com.xsolla.gold_1",
"name": {
"en": "Gold",
"ru": "Gold"
},
"type": "virtual_currency",
"quantity": 100
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
},
{
"sku": "com.xsolla.gold_pack_2",
"name": {
"en": "Medium gold pack"
},
"type": "bundle",
"description": {
"en": "Gold x500"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/b5d8130bdaf28aa55c43a68aa3ca0ef4.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 20,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Money for in-store purchases"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png",
"sku": "com.xsolla.gold_2",
"name": {
"en": "Gold",
"ru": "Gold"
},
"type": "virtual_currency",
"quantity": 500
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
},
{
"sku": "com.xsolla.gold_pack_3",
"name": {
"en": "Large gold pack"
},
"type": "bundle",
"description": {
"en": "Gold x1500"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/dea74a3667807d5502a4acb8f4c879ca.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 50,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Money for in-store purchases"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png",
"sku": "com.xsolla.gold_3",
"name": {
"en": "Gold",
"ru": "Gold"
},
"type": "virtual_currency",
"quantity": 1500
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
}
]
},
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency-package"
}
}
}
}
}
}
},
"Virtual-Items-Currency_200-admin-get-virtual-currency-package": {
"description": "Указанный пакет виртуальной валюты успешно получен.",
"content": {
"application/json": {
"example": {
"sku": "com.xsolla.crystal_pack_1",
"name": {
"en": "Small crystal pack"
},
"type": "bundle",
"description": {
"en": "Crystals x100"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/a8682cea328afda0bd127d59eb5b9077.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"is_paid_randomized_reward": true,
"order": 1,
"groups": [],
"prices": [
{
"amount": 5,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"quantity": 100
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency-package"
}
}
}
},
"Virtual-Items-Currency_200-get-items-list": {
"description": "Список виртуальных предметов успешно получен.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_item-list"
},
"examples": {
"response": {
"value": {
"has_more": true,
"items": [
{
"sku": "com.xsolla.big_rocket_1",
"name": {
"en": "Big Rocket"
},
"groups": [
{
"external_id": "accessory",
"name": "accessory",
"item_order_in_group": 1
}
],
"attributes": [
{
"external_id": "stack_size",
"name": {
"en": "Stack size"
},
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
}
],
"type": "virtual_good",
"description": {
"en": "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": [],
"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
}
],
"loyalty_prices": [
{
"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": 200
}
]
},
{
"sku": "com.xsolla.shotgun_raider_1",
"name": {
"en": "SHOTGUN FOR TRUE RAIDERS"
},
"groups": [
{
"external_id": "weapons",
"name": "Weapons",
"item_order_in_group": 1
}
],
"attributes": [
{
"external_id": "stack_size",
"name": {
"en": "Stack size"
},
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
},
{
"external_id": "rating",
"name": {
"en": "Rating"
},
"values": [
{
"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"type": "virtual_good",
"description": {
"en": "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_1",
"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_2",
"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": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"vp_rewards": []
},
{
"sku": "com.xsolla.shotgun_raider_2",
"name": {
"en": "SHOTGUN FOR TRUE RAIDERS"
},
"groups": [],
"attributes": [],
"type": "virtual_good",
"description": {
"en": "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": [],
"loyalty_rewards": [],
"loyalty_prices": []
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-item-by-sku": {
"description": "Виртуальный товар был успешно получен.",
"content": {
"application/json": {
"example": {
"item_id": 488833,
"sku": "com.xsolla.swords_1",
"type": "virtual_good",
"name": {
"en": "Sword Xsolla Skin"
},
"description": {
"en": "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/8ab44fe99038a56de01950ba4a971b77.png",
"price": {
"amount": "4.99",
"amount_without_discount": "4.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"limits": {
"per_user": {
"total": 3,
"available": 1,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1761840000
},
"limit_exceeded_visibility": "show"
},
"per_item": null
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": "VALUE"
},
{
"external_id": "val2",
"value": "VALUE2"
}
]
}
],
"is_free": false,
"groups": [
{
"external_id": "weapons",
"name": "weapons"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": [],
"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
}
],
"loyalty_prices": [
{
"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": 200
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_item"
}
}
}
},
"Virtual-Items-Currency_200-get-all-items-list": {
"description": "Список всех виртуальных предметов успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Объект с виртуальными предметами.",
"properties": {
"items": {
"type": "array",
"example": [
{
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"description": "Big Rocket - description",
"groups": [
{
"external_id": "accessory",
"name": {
"en": "accessory"
}
}
]
},
{
"sku": "com.xsolla.shotgun_raider_1",
"name": "SHOTGUN FOR TRUE RAIDERS",
"description": "description",
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
}
]
},
{
"sku": "com.xsolla.shotgun_raider_2",
"name": "SHOTGUN FOR TRUE RAIDERS",
"description": "description",
"groups": []
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "com.xsolla.big_rocket_1",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"name": {
"type": "string",
"example": "Big Rocket",
"description": "Название товара."
},
"groups": {
"type": "array",
"properties": {
"external_id": {
"type": "string",
"example": "weapons"
},
"name": {
"type": "object",
"additionalProperties": {
"type": [
"string",
"null"
]
}
}
}
},
"description": {
"type": "string",
"example": "Big Rocket - description",
"description": "Описание товара."
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"items": [
{
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"groups": [
{
"external_id": "accessory",
"name": {
"en": "Accessory"
}
}
],
"description": "Big Rocket - description"
},
{
"sku": "com.xsolla.shotgun_raider_1",
"name": "SHOTGUN FOR TRUE RAIDERS",
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
}
],
"description": "description"
},
{
"sku": "com.xsolla.shotgun_raider_2",
"name": "SHOTGUN FOR TRUE RAIDERS",
"groups": [],
"description": "description"
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-virtual-currency-list": {
"description": "Список виртуальных валют успешно получен.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-list"
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"sku": "com.xsolla.crystal_1",
"name": "Crystals",
"groups": [
{
"external_id": "game_currencies",
"name": "VC",
"item_order_in_group": 1
}
],
"attributes": [
{
"external_id": "attr1",
"name": {
"en-US": "Attribute"
},
"values": [
{
"external_id": "val1",
"value": "Value"
},
{
"external_id": "val2",
"value": "Value"
}
]
}
],
"type": "virtual_currency",
"description": "Crystals - short description",
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.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": "Virtual currency name",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"promotions": [],
"limits": null,
"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": [],
"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
}
],
"loyalty_prices": [
{
"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": 200
}
]
},
{
"sku": "com.xsolla.emerald_1",
"name": "Emeralds",
"groups": [
{
"external_id": "game_currencies",
"name": "VC",
"item_order_in_group": 2
}
],
"attributes": [
{
"external_id": "attr1",
"name": {
"en-US": "Attribute"
},
"values": [
{
"external_id": "val1",
"value": "Value"
},
{
"external_id": "val2",
"value": "Value"
}
]
},
{
"external_id": "rating",
"name": {
"en": "Rating"
},
"values": [
{
"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"type": "virtual_currency",
"description": "Emeralds - short description",
"image_url": "http://image.png",
"is_free": false,
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"limits": null,
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"vp_rewards": [],
"loyalty_rewards": [],
"loyalty_prices": []
},
{
"sku": "com.xsolla.diamond_1",
"name": "Diamonds",
"groups": [],
"attributes": [],
"type": "virtual_currency",
"description": "Diamonds - description",
"image_url": "http://image.png",
"is_free": true,
"price": null,
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"limits": null,
"periods": [],
"vp_rewards": [],
"loyalty_rewards": [],
"loyalty_prices": []
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-virtual-currency": {
"description": "Виртуальная валюта была успешно получена.",
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"item_id": 451414,
"sku": "com.xsolla.crystal_1",
"type": "virtual_currency",
"name": "Crystals",
"description": "Crystals - short description",
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"price": {
"amount": "100",
"amount_without_discount": "100",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"limits": null,
"periods": [
{
"date_from": "2023-08-11T10:00:00+03:00",
"date_until": "2023-08-11T20:00:00+03:00"
}
],
"attributes": [
{
"external_id": "attr1",
"name": {
"en-US": "Attribute"
},
"values": [
{
"external_id": "val1",
"value": "Value"
},
{
"external_id": "val2",
"value": "Value"
}
]
}
],
"is_free": false,
"groups": [],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"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"
}
],
"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
}
],
"loyalty_prices": [
{
"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": 200
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency"
}
}
}
},
"Virtual-Items-Currency_200-get-virtual-currency-packages-list": {
"description": "Список пакетов виртуальной валюты успешно получен.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-packages"
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"sku": "com.xsolla.vc_package_1",
"name": "VC Name first package",
"groups": [
{
"external_id": "gift",
"name": "Gift",
"item_order_in_group": 1
}
],
"attributes": [],
"type": "bundle",
"description": "VC Short Package Description",
"image_url": "http://vc_package_image.png",
"is_free": false,
"price": {
"amount": "2.0000",
"amount_without_discount": "2.0000",
"currency": "USD"
},
"bundle_type": "virtual_currency_package",
"content": [
{
"description": "Crystals - short description",
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "com.xsolla.crystal_1",
"name": "Crystals",
"type": "virtual_currency",
"quantity": 100,
"limits": null
}
],
"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"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"can_be_bought": true,
"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": [],
"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
}
],
"loyalty_prices": [
{
"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": 200
}
]
},
{
"sku": "com.xsolla.vc_package_3",
"name": "VC Name third package",
"groups": [
{
"external_id": "gift",
"name": "Gift",
"item_order_in_group": 2
}
],
"attributes": [],
"type": "bundle",
"description": "VC Short Package Description",
"image_url": "http://vc_package_image.png",
"is_free": false,
"price": {
"amount": "4.0000",
"amount_without_discount": "4.0000",
"currency": "USD"
},
"bundle_type": "virtual_currency_package",
"content": [
{
"description": "description",
"image_url": "http://image.png",
"sku": "com.xsolla.emerald_1",
"name": "Emeralds",
"type": "virtual_currency",
"quantity": 200,
"limits": null
}
],
"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"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"can_be_bought": true,
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"vp_rewards": [],
"loyalty_rewards": [],
"loyalty_prices": []
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-virtual-currency-package": {
"description": "Пакет виртуальной валюты был успешно получен.",
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"item_id": 488832,
"sku": "com.xsolla.crystal_pack_1",
"type": "bundle",
"name": "Crystal Pack",
"bundle_type": "virtual_currency_package",
"description": "Crystal Pack Short Description",
"image_url": "http://vc_package_image.png",
"price": {
"amount": "100",
"amount_without_discount": "100",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"limits": {
"per_user": {
"total": 1,
"available": 1,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1690732800
},
"limit_exceeded_visibility": "show"
},
"per_item": null
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 488831,
"sku": "com.xsolla.crystals_1",
"type": "virtual_currency",
"name": "Crystals",
"description": "Crystal - short description",
"image_url": "https://cdn.xsolla.net/items/crystal-pack.png",
"quantity": 10,
"limits": null
}
],
"vp_rewards": [],
"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
}
],
"loyalty_prices": [
{
"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": 200
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
}
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-package"
}
}
}
},
"Virtual-Items-Currency_200-get-items-by-group-id": {
"description": "Список предметов из указанной группы успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"example": [
{
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"groups": [
{
"external_id": "weapons",
"name": "weapons"
}
],
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"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": {
"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"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
},
"per_item": null
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.shotgun_raider",
"name": "SHOTGUN FOR TRUE RAIDERS",
"groups": [
{
"external_id": "weapons",
"name": {
"en": "weapons"
}
}
],
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"value": "5"
}
]
},
{
"external_id": "rating",
"name": "Rating",
"values": [
{
"value": "3.9"
}
]
},
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"value": "Strategy"
},
{
"value": "Tactical"
},
"Turn-based"
]
}
],
"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_1",
"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_2",
"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": []
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "com.xsolla.big_rocket_1",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"name": {
"type": "string",
"example": "Big Rocket",
"description": "Название товара."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "Тип предмета: `consumable`/`expiration`/`permanent`/`lootboxes`/`physical`."
},
"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",
"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"
},
"loyalty_rewards": {
"$ref": "#/components/schemas/item-loyalty-point-reward"
},
"loyalty_prices": {
"$ref": "#/components/schemas/item-loyalty-point-prices"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"groups": [
{
"external_id": "weapons",
"name": "weapons",
"item_order_in_group": 1
}
],
"attributes": [
{
"external_id": "stack_size",
"name": {
"en": "Stack size"
},
"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": {
"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"
}
]
}
],
"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": [
{
"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
}
],
"loyalty_prices": [
{
"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": 200
}
]
},
{
"sku": "com.xsolla.shotgun_raider_1",
"name": "SHOTGUN FOR TRUE RAIDERS",
"groups": [
{
"external_id": "weapons",
"name": "weapons",
"item_order_in_group": 2
}
],
"attributes": [
{
"external_id": "stack_size",
"name": {
"en": "Stack size"
},
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
},
{
"external_id": "rating",
"name": {
"en": "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_1",
"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_2",
"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": [
{
"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"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"periods": [],
"vp_rewards": [],
"loyalty_rewards": [],
"loyalty_prices": []
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_404-item-group": {
"description": "Группа не найдена. Убедитесь, что верно указали `external_id` и группа не отключена и не удалена.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"description": "Код HTTP-статуса ответа.",
"example": 404
},
"errorCode": {
"type": "integer",
"description": "Код ошибки Xsolla",
"example": 4403
},
"errorMessage": {
"type": "string",
"description": "Краткое описание ошибки.",
"example": "[0401-4403]: Item group not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Item group not found"
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-virtual-currency-by-group-id": {
"description": "Список виртуальных валют из указанной группы получен успешно.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-list"
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"sku": "com.xsolla.crystal_1",
"name": "Crystals",
"groups": [
{
"external_id": "game_currencies",
"name": "VC",
"item_order_in_group": 1
}
],
"attributes": [
{
"external_id": "attr1",
"name": {
"en-US": "Attribute"
},
"values": [
{
"external_id": "val1",
"value": "Value"
},
{
"external_id": "val2",
"value": "Value"
}
]
}
],
"type": "virtual_currency",
"description": "Crystals - short description",
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.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": "Virtual currency name",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"promotions": [],
"limits": null,
"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": [],
"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
}
],
"loyalty_prices": [
{
"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": 200
}
]
},
{
"sku": "com.xsolla.emerald_1",
"name": "Emeralds",
"groups": [
{
"external_id": "game_currencies",
"name": "VC",
"item_order_in_group": 2
}
],
"attributes": [
{
"external_id": "attr1",
"name": {
"en-US": "Attribute"
},
"values": [
{
"external_id": "val1",
"value": "Value"
},
{
"external_id": "val2",
"value": "Value"
}
]
},
{
"external_id": "rating",
"name": {
"en": "Rating"
},
"values": [
{
"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"type": "virtual_currency",
"description": "Emeralds - short description",
"image_url": "http://image.png",
"is_free": false,
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"limits": null,
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"vp_rewards": [],
"loyalty_rewards": [],
"loyalty_prices": []
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-virtual-currency-packages-by-group-id": {
"description": "Список пакетов виртуальной валюты из указанной группы получен успешно.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-packages"
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"sku": "com.xsolla.vc_package_1",
"name": "VC Name first package",
"groups": [
{
"external_id": "gift",
"name": "Gift",
"item_order_in_group": 1
}
],
"attributes": [],
"type": "bundle",
"description": "VC Short Package Description",
"image_url": "http://vc_package_image.png",
"is_free": false,
"price": {
"amount": "2.0000",
"amount_without_discount": "2.0000",
"currency": "USD"
},
"bundle_type": "virtual_currency_package",
"content": [
{
"description": "Crystals - short description",
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "com.xsolla.crystal_1",
"name": "Crystals",
"type": "virtual_currency",
"quantity": 100,
"limits": null
}
],
"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"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"can_be_bought": true,
"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": [],
"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
}
],
"loyalty_prices": [
{
"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": 200
}
]
},
{
"sku": "com.xsolla.vc_package_3",
"name": "VC Name third package",
"groups": [
{
"external_id": "gift",
"name": "Gift",
"item_order_in_group": 2
}
],
"attributes": [],
"type": "bundle",
"description": "VC Short Package Description",
"image_url": "http://vc_package_image.png",
"is_free": false,
"price": {
"amount": "4.0000",
"amount_without_discount": "4.0000",
"currency": "USD"
},
"bundle_type": "virtual_currency_package",
"content": [
{
"description": "description",
"image_url": "http://image.png",
"sku": "com.xsolla.emerald_1",
"name": "Emeralds",
"type": "virtual_currency",
"quantity": 200,
"limits": null
}
],
"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"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"can_be_bought": true,
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"vp_rewards": [],
"loyalty_rewards": [],
"loyalty_prices": []
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-items-groups": {
"description": "Список групп успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"example": [
{
"external_id": "weapons",
"name": "Weapons",
"description": "All weapons available in the game",
"image_url": null,
"order": 1
},
{
"external_id": "group_external_id",
"name": "Super",
"description": "Super description",
"image_url": null,
"order": 1
}
],
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "weapons",
"description": "External ID группы."
},
"name": {
"type": "string",
"example": "Weapons",
"description": "Название группы."
},
"description": {
"type": "string",
"example": "All weapons available in the game",
"description": "Описание группы."
},
"image_url": {
"type": [
"string",
"null"
],
"example": null,
"description": "URL-адрес изображения."
},
"order": {
"type": "integer",
"example": 1,
"description": "Определяет порядок расположения."
},
"level": {
"type": "integer",
"example": 0,
"description": "Уровень вложенности группы."
},
"children": {
"type": "array",
"example": [
{
"external_id": "background",
"name": "Background",
"description": "Background description",
"image_url": null,
"order": 1,
"level": 1,
"children": [
{
"external_id": "accessory",
"name": "Accessory",
"description": "Accessory",
"image_url": null,
"order": 1,
"level": 2,
"children": [],
"parent_external_id": "background"
}
],
"parent_external_id": "weapons"
}
],
"description": "Дочерние группы.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "background",
"description": "External ID группы."
},
"name": {
"type": "string",
"example": "Background",
"description": "Название группы."
},
"description": {
"type": "string",
"example": "Background description",
"description": "Описание группы."
},
"image_url": {
"type": [
"string",
"null"
],
"example": null,
"description": "URL-адрес изображения группы."
},
"order": {
"type": "integer",
"example": 1,
"description": "Определяет порядок расположения."
},
"level": {
"type": "integer",
"example": 1,
"description": "Уровень вложенности группы."
},
"children": {
"type": "array",
"example": [
{
"external_id": "accessory",
"name": "Accessory",
"description": "Accessory",
"image_url": null,
"order": 1,
"level": 2,
"children": [],
"parent_external_id": "background"
}
],
"description": "Дочерние группы.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "accessory",
"description": "External ID группы."
},
"name": {
"type": "string",
"example": "Accessory",
"description": "Название группы."
},
"description": {
"type": "string",
"example": "Accessory",
"description": "Описание группы."
},
"image_url": {
"type": [
"string",
"null"
],
"example": null,
"description": "URL-адрес изображения."
},
"order": {
"type": "integer",
"example": 1,
"description": "Определяет порядок расположения."
},
"level": {
"type": "integer",
"example": 2,
"description": "Уровень вложенности группы."
},
"children": {
"type": "array",
"example": [],
"description": "Дочерние группы.",
"items": {
"type": "string"
}
},
"parent_external_id": {
"type": [
"string",
"null"
],
"example": "background",
"description": "Путь к каталогу (родительская папка группы)."
}
}
}
},
"parent_external_id": {
"type": [
"string",
"null"
],
"example": "weapons",
"description": "Путь к каталогу (родительская папка группы)."
}
}
}
},
"parent_external_id": {
"type": [
"string",
"null"
],
"example": null,
"description": "Путь к каталогу (родительская папка группы)."
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"groups": [
{
"external_id": "weapons",
"name": "Weapons",
"description": "All weapons available in the game",
"image_url": "https://example.com/groups/weapons.png",
"order": 1
},
{
"external_id": "armor",
"name": "Armor",
"description": "Protective equipment",
"image_url": "https://example.com/groups/armor.png",
"order": 2
},
{
"external_id": "consumables",
"name": "Consumables",
"description": "Potions, food, and other single-use items",
"image_url": null,
"order": 3
}
]
}
}
}
}
}
},
"ItemGroup_200-admin-get-group-list": {
"description": "Список групп товаров успешно получен. ",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/admin-group-response-base"
}
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/200-admin-get-group-list"
}
}
}
}
},
"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"
}
}
}
}
}
},
"ItemGroup_201-admin-create-group": {
"description": "Группа товаров успешно создана.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"description": "Внешний ID группы товаров, который был указан при создании.",
"example": "weapons"
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/201-admin-create-group"
}
}
}
}
},
"ItemGroup_422-create-update": {
"description": "Запрос не может быть обработан. Возвращается при ошибках валидации или если данные противоречат правилам системы.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemGroup_422-invalid-request"
},
"examples": {
"The property `external_id` is required": {
"$ref": "#/components/examples/422-property-external-id-required"
},
"Group already exists": {
"value": {
"statusCode": 422,
"errorCode": 4401,
"errorMessage": "[0401-4401]: Item group already exists",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"Group cannot be its own parent": {
"value": {
"statusCode": 422,
"errorCode": 4404,
"errorMessage": "[0401-4404]: Group can't be self parent",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"Reserved external_id value": {
"value": {
"statusCode": 422,
"errorCode": 4516,
"errorMessage": "[0401-4516]: Value 'tools' not allowed to be used for the property 'external_id'.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"ItemGroup_200-admin-get-group": {
"description": "Группа товаров успешно получена.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/admin-group-response-base"
},
"examples": {
"response": {
"$ref": "#/components/examples/200-admin-get-group"
}
}
}
}
},
"ItemGroup_404-group-not-found": {
"description": "Группа товаров не найдена. Ошибка возвращается, если группа с указанным `external_id` не существует или принадлежит другому проекту.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error-response-base"
},
{
"type": "object",
"properties": {
"errorMessageExtended": {
"type": [
"object",
"null"
],
"description": "ID, использованные при поиске, который не дал результата.",
"properties": {
"project_id": {
"type": "integer",
"description": "ID проекта, использованный при поиске."
},
"external_id_list": {
"type": "array",
"description": "Список `external_id` групп, использованных при поиске.",
"items": {
"type": "string"
}
},
"group_id_list": {
"type": "array",
"description": "Список `id` групп, использованных при поиске.",
"items": {
"type": "integer"
}
}
}
}
}
}
]
},
"examples": {
"Group not found by external_id": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Group with external id = 'weapons' not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 123,
"external_id_list": [
"weapons"
]
}
}
},
"Group not found by ID": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Group with id in (99) and projectId = 123 not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 123,
"group_id_list": [
99
]
}
}
},
"Items or group not found (reorder endpoints)": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Items or group were not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {}
}
}
}
}
}
},
"ItemGroup_204-admin-update-group": {
"description": "Группа товаров успешно обновлена."
},
"ItemGroup_204-admin-delete-group": {
"description": "Группа товаров успешно удалена."
},
"ItemGroup_422-delete": {
"description": "Запрос не может быть обработан. Невозможно удалить группу, содержащую товары.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemGroup_422-invalid-request"
},
"examples": {
"Cannot delete group with items": {
"value": {
"statusCode": 422,
"errorCode": 4402,
"errorMessage": "[0401-4402]: Item group with items cannot be deleted.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"ItemGroup_200-admin-get-group-list-by-item-type": {
"description": "Список групп товаров успешно получен. Поле `items_count` учитывает только товары указанного типа.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/admin-group-response-by-item-type"
}
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/200-admin-get-group-list-by-item-type"
}
}
}
}
},
"ItemGroup_200-admin-get-group-by-item-type": {
"description": "Список групп товаров успешно получен. Поле `items_count` учитывает только товары указанного типа.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/admin-group-detail-response-by-item-type"
},
"examples": {
"response": {
"$ref": "#/components/examples/200-admin-get-group-by-item-type"
}
}
}
}
},
"ItemGroup_204-admin-reorder-groups": {
"description": "Порядок групп товаров успешно обновлен."
},
"ItemGroup_404-reorder-groups-not-found": {
"description": "Группа товаров не найдена. Ошибка возвращается, если группа с указанным `id` или `external_id` существует или принадлежит другому проекту.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error-response-base"
},
{
"type": "object",
"properties": {
"errorMessageExtended": {
"type": [
"object",
"null"
],
"description": "ID, использованные при поиске, который не дал результата.",
"properties": {
"project_id": {
"type": "integer",
"description": "ID проекта, использованный при поиске."
},
"external_id_list": {
"type": "array",
"description": "Список `external_id` групп, использованных при поиске.",
"items": {
"type": "string"
}
},
"group_id_list": {
"type": "array",
"description": "Список `id` групп, использованных при поиске.",
"items": {
"type": "integer"
}
}
}
}
}
}
]
},
"examples": {
"Group not found by external_id": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Group with external id = 'weapons' not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 123,
"external_id_list": [
"weapons"
]
}
}
},
"Group not found by ID": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Group with id in (99) and projectId = 123 not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 123,
"group_id_list": [
99
]
}
}
}
}
}
}
},
"ItemGroup_422-ordering": {
"description": "Запрос не может быть обработан. Тело запроса не прошло валидацию.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemGroup_422-invalid-request"
},
"examples": {
"Invalid request body": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": [
{
"property": "",
"message": "Object value found, but an array is required"
}
]
}
}
}
}
}
},
"ItemGroup_204-admin-reorder-items": {
"description": "Порядок товаров в группе успешно обновлен."
},
"ItemGroup_404-reorder-items-by-external-id-not-found": {
"description": "Группа товаров или товары не найдены. Ошибка возвращается, если группа с указанным `external_id` не существует или принадлежит другому проекту или один или более `item_id` не были найдены в группе.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error-response-base"
},
{
"type": "object",
"properties": {
"errorMessageExtended": {
"type": [
"object",
"null"
],
"description": "ID, использованные при поиске, который не дал результата.",
"properties": {
"project_id": {
"type": "integer",
"description": "ID проекта, использованный при поиске."
},
"external_id_list": {
"type": "array",
"description": "Список `external_id` групп, использованных при поиске.",
"items": {
"type": "string"
}
}
}
}
}
}
]
},
"examples": {
"Items or group not found": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Items or group were not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {}
}
}
}
}
}
},
"ItemGroup_404-reorder-items-by-id-not-found": {
"description": "Группа товаров или товары не найдены. Ошибка возвращается, если группа с указанным `id` не существует или принадлежит другому проекту или один или более `item_id` не были найдены в группе.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error-response-base"
},
{
"type": "object",
"properties": {
"errorMessageExtended": {
"type": [
"object",
"null"
],
"description": "ID, использованные при поиске, который не дал результата.",
"properties": {
"project_id": {
"type": "integer",
"description": "ID проекта, использованный при поиске."
},
"group_id_list": {
"type": "array",
"description": "Список `id` групп, использованных при поиске.",
"items": {
"type": "integer"
}
}
}
}
}
}
]
},
"examples": {
"Items or group not found": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Items or group were not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {}
}
}
}
}
}
},
"Virtual-Items-Currency_200-quick-purchase": {
"description": "Успешная быстрая виртуальная покупка.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"description": "ID заказа."
}
}
},
"examples": {
"response": {
"value": {
"order_id": 641
}
}
}
}
}
},
"Virtual-Items-Currency_422-not-enough-virtual-currency": {
"description": "Недостаточно виртуальной валюты.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"example": 5006
},
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "[0401-5006]: Not enough virtual currency"
}
}
},
"examples": {
"response": {
"value": {
"errorCode": 5006,
"statusCode": 422,
"errorMessage": "[0401-5006]: Not enough virtual currency"
}
}
}
}
}
},
"Game-Keys_200-get-games-catalog": {
"description": "Список игр успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Объект с играми.",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"example": [
{
"sku": "com.xsolla.game_1",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla games"
}
],
"type": "unit",
"unit_type": "game",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"promotions": [],
"unit_items": [
{
"sku": "com.xsolla.game_key_01",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"has_keys": true,
"is_pre_order": true,
"release_date": "2020-08-11T10:00:00+03:00",
"promotions": [],
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.game_key_02",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Origin",
"drm_sku": "origin_key_1",
"has_keys": false,
"is_pre_order": false,
"release_date": null,
"promotions": [],
"periods": []
}
]
},
{
"sku": "com.xsolla.game_2",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games"
}
],
"type": "unit",
"unit_type": "game",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
}
],
"promotions": [],
"unit_items": [
{
"sku": "com.xsolla.game_key_01",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Steam",
"drm_sku": "steam_key_2",
"has_keys": false,
"is_pre_order": false,
"release_date": null,
"promotions": [],
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
]
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "game_01",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"name": {
"type": "string",
"example": "Game name",
"description": "Название товара."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_schemas-client-attributes"
},
"type": {
"type": "string",
"example": "unit",
"description": "Тип товара: `virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`."
},
"unit_type": {
"type": "string",
"example": "game",
"description": "Тип: `game`."
},
"description": {
"type": "string",
"example": "Game description",
"description": "Описание товара."
},
"image_url": {
"type": "string",
"example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"description": "URL-адрес изображения."
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"unit_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "game_01",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"type": {
"type": "string",
"example": "game_key",
"description": "Тип товара: `game_key`."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"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)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"drm_name": {
"type": "string",
"example": "Steam",
"description": "Название платформы распространения игры."
},
"drm_sku": {
"type": "string",
"example": "steam",
"description": "Уникальный ID платформы. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"has_keys": {
"type": "boolean",
"example": false,
"description": "Если `true`, у игры на платформе есть игровые ключи для продажи."
},
"is_pre_order": {
"type": "boolean",
"example": true,
"description": "Если `true`, игра на платформе находится в предзаказе и дата релиза еще не прошла."
},
"release_date": {
"type": [
"string",
"null"
],
"example": "2020-08-11T10:00:00+03:00",
"description": "Дата выпуска игры на платформе в формате ISO 8601."
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
},
"loyalty_rewards": {
"$ref": "#/components/schemas/item-loyalty-point-reward"
},
"loyalty_prices": {
"$ref": "#/components/schemas/item-loyalty-point-prices"
}
}
}
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"sku": "com.xsolla.game_1",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games",
"item_order_in_group": 2
},
{
"external_id": "Xsolla",
"name": "Xsolla games",
"item_order_in_group": 1
}
],
"type": "unit",
"unit_type": "game",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"promotions": [],
"unit_items": [
{
"sku": "com.xsolla.game_key_01",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"has_keys": true,
"is_pre_order": true,
"release_date": "2020-08-11T10:00:00+03:00",
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"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
}
],
"loyalty_prices": [
{
"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": 200
}
]
},
{
"sku": "com.xsolla.game_key_02",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Origin",
"drm_sku": "origin_key_1",
"has_keys": false,
"is_pre_order": false,
"release_date": null,
"periods": [],
"vp_rewards": [],
"loyalty_rewards": [],
"loyalty_prices": []
}
]
},
{
"sku": "com.xsolla.game_2",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games",
"item_order_in_group": 1
}
],
"type": "unit",
"unit_type": "game",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
}
],
"promotions": [],
"unit_items": [
{
"sku": "com.xsolla.game_key_01",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"has_keys": false,
"is_pre_order": false,
"release_date": null,
"periods": [
{
"date_from": "2020-08-11T20:00:00+03:00",
"date_until": null
}
],
"vp_rewards": [],
"loyalty_rewards": [],
"loyalty_prices": []
}
]
}
]
}
}
}
}
}
},
"Game-Keys_200-get-game-keys-by-group-catalog": {
"description": "Список игр успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Объект с играми.",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"example": [
{
"sku": "com.xsolla.game_1",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla games"
}
],
"type": "game_key",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
},
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"has_keys": true,
"is_pre_order": true,
"release_date": "2020-08-11T10:00:00+03:00",
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.game_2",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games"
}
],
"type": "game_key",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
},
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"drm_name": "Steam",
"drm_sku": "steam_key_2",
"has_keys": true,
"is_pre_order": false,
"release_date": null,
"periods": []
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "game_01",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"name": {
"type": "string",
"example": "Game name",
"description": "Название товара."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_schemas-client-attributes"
},
"type": {
"type": "string",
"example": "game_key",
"description": "Тип товара: `game_key`."
},
"description": {
"type": "string",
"example": "Game description",
"description": "Описание товара."
},
"image_url": {
"type": "string",
"example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"description": "URL-адрес изображения."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"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)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"drm_name": {
"type": "string",
"example": "Steam",
"description": "Название платформы распространения игры."
},
"drm_sku": {
"type": "string",
"example": "steam",
"description": "Уникальный ID платформы. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"has_keys": {
"type": "boolean",
"example": false,
"description": "Если `true`, у игры на платформе есть игровые ключи для продажи."
},
"is_pre_order": {
"type": "boolean",
"example": true,
"description": "Если `true`, игра на платформе находится в предзаказе и дата релиза еще не прошла."
},
"release_date": {
"type": [
"string",
"null"
],
"example": "2020-08-11T10:00:00+03:00",
"description": "Дата выпуска игры на платформе в формате ISO 8601."
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"loyalty_rewards": {
"$ref": "#/components/schemas/item-loyalty-point-reward"
},
"loyalty_prices": {
"$ref": "#/components/schemas/item-loyalty-point-prices"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": true,
"items": [
{
"sku": "com.xsolla.game_1",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games",
"item_order_in_group": 2
},
{
"external_id": "Xsolla",
"name": "Xsolla games",
"item_order_in_group": 1
}
],
"type": "game_key",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
},
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"has_keys": true,
"is_pre_order": true,
"release_date": "2020-08-11T10:00:00+03:00",
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"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
}
],
"loyalty_prices": [
{
"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": 200
}
]
},
{
"sku": "com.xsolla.game_2",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games",
"item_order_in_group": 1
}
],
"type": "game_key",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
},
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"drm_name": "Steam",
"drm_sku": "steam_key_2",
"has_keys": true,
"is_pre_order": false,
"release_date": null,
"periods": [],
"loyalty_rewards": [],
"loyalty_prices": []
}
]
}
}
}
}
}
},
"Game-Keys_200-get-drm-list": {
"description": "Список платформ успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Объект с играми.",
"properties": {
"drm": {
"type": "array",
"example": [
{
"sku": "steam_key_1",
"name": "Steam",
"image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"link": "https://support.steampowered.com",
"redeem_instruction_link": "https://support.steampowered.com",
"drm_id": 1
},
{
"sku": "playstation_key_1",
"name": "Playstation",
"image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"link": null,
"redeem_instruction_link": "https://support.us.playstation.com",
"drm_id": 2
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "steam",
"description": "Уникальный ID платформы. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"name": {
"type": "string",
"example": "Steam",
"description": "Название платформы распространения игры."
},
"image": {
"type": "string",
"example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"description": "URL-адрес изображения."
},
"link": {
"type": [
"string",
"null"
],
"example": "https://support.us.playstation.com",
"description": "Ссылка для активации ключа."
},
"redeem_instruction_link": {
"type": "string",
"example": "https://support.us.playstation.com",
"description": "Ссылка на инструкцию по активации."
},
"drm_id": {
"type": "number",
"example": 1,
"description": "ID платформы."
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"drm": [
{
"sku": "steam_key_1",
"name": "Steam",
"image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"link": "https://support.steampowered.com",
"redeem_instruction_link": "https://support.steampowered.com",
"drm_id": 1
},
{
"sku": "playstation_key_1",
"name": "Playstation",
"image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"link": null,
"redeem_instruction_link": "https://support.us.playstation.com",
"drm_id": 2
}
]
}
}
}
}
}
},
"Game-Keys_200-admin-get-games-list": {
"description": "Список игр успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Объект с играми.",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"example": 1,
"description": "Внутренний уникальный ID товара, который задается при создании товара."
},
"sku": {
"type": "string",
"example": "game_1",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"type": {
"type": "string",
"example": "unit",
"description": "Тип товара. В данном случае это всегда `unit`."
},
"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": {
"type": "string",
"example": "https://image.example.com",
"description": "URL-адрес изображения."
},
"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": "Ссылка на файл."
}
}
}
},
"is_enabled": {
"type": "boolean",
"description": "Если этот параметр отключен, товар нельзя приобрести и получить к нему доступ через инвентарь."
},
"is_show_in_store": {
"type": "boolean",
"description": "Товар доступен для покупки."
},
"order": {
"type": "integer",
"example": 1,
"description": "Приоритет порядка игры в списке."
},
"groups": {
"type": "array",
"example": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"description": "Группы, к которым принадлежит товар.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
},
"name": {
"type": "object",
"example": {
"en": "Horror"
}
}
}
}
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_admin-attributes"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"unit_items": {
"type": "array",
"description": "Платформы публикации игры.",
"items": {
"type": "object",
"description": "Игра, опубликованная на определенной платформе (steam, gog и т.д.).",
"properties": {
"item_id": {
"type": "integer",
"example": 1,
"description": "Внутренний уникальный ID товара, который задается при создании товара."
},
"sku": {
"type": "string",
"example": "game_1",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"type": {
"type": "string",
"example": "game_key",
"description": "Тип товара. В данном случае это всегда `game_key`."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"prices": {
"type": "array",
"description": "Цены в реальных валютах.",
"example": [
{
"amount": 1299.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true
}
],
"items": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"example": 1299.99
},
"currency": {
"type": "string",
"example": "RUB",
"description": "Валюта, в которой указана цена товара. Трехбуквенный код в соответствии со стандартом [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
},
"is_default": {
"type": "boolean",
"description": "Цена по умолчанию используется для построения каталога, если цена в валюте пользователя не указана."
},
"is_enabled": {
"type": "boolean"
},
"country_iso": {
"type": [
"string",
"null"
],
"example": "US",
"description": "Страна, где доступна эта цена. Двухбуквенный код в соответствии с [ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)."
}
}
}
},
"virtual_prices": {
"type": [
"array",
"null"
],
"example": [
{
"sku": "com.xsolla.gold_1",
"name": {
"en": "Gold"
},
"type": "virtual_currency",
"description": null,
"image_url": "https://i.pinimg.com/originals/91/ae/56/91ae5683045f6dbef16b1482bade938f.png",
"amount": 1000,
"is_default": true
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "gold",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"name": {
"type": "object",
"additionalProperties": true,
"example": {
"en": "Gold"
},
"description": "Объект с локализациями для названия виртуальной валюты. Ключи для обозначения стран указаны в стандарте ISO 3166-1."
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "Тип товара. В данном случае это всегда `virtual_currency`."
},
"description": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"example": {
"en": "Game 1 Example"
},
"description": "Объект с локализациями для описания игры. Игровые ключи для обозначения стран указаны в стандарте ISO 3166-1."
},
"image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "URL-адрес изображения."
},
"amount": {
"type": "number"
},
"is_default": {
"type": "boolean"
}
}
}
},
"order": {
"type": "integer",
"example": 1,
"description": "Приоритет порядка игры в списке."
},
"is_enabled": {
"type": "boolean",
"description": "Если этот параметр отключен, товар нельзя приобрести и получить к нему доступ через инвентарь."
},
"is_show_in_store": {
"type": "boolean",
"description": "Товар доступен для покупки."
},
"drm_name": {
"type": "string",
"example": "Steam",
"description": "Название игры на платформе."
},
"drm_sku": {
"type": "string",
"example": "steam",
"description": "Уникальный ID платформы."
},
"drm_image": {
"type": [
"string",
"null"
],
"example": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png",
"description": "Значок игры на платформе."
},
"drm_id": {
"type": "integer",
"example": 1,
"description": "Внутренний уникальный ID платформы."
},
"keys": {
"type": "object",
"properties": {
"available": {
"type": "integer",
"description": "Количество игровых ключей, доступных для покупки."
},
"total": {
"type": "integer",
"description": "Общее количество загруженных игровых ключей."
},
"used": {
"type": "integer",
"description": "Количество проданных игровых ключей."
}
}
},
"is_sales_exist": {
"type": "boolean",
"description": "Если `true`, зафиксированы продажи игры на данной платформе."
},
"pre_order": {
"type": "object",
"description": "Настройки предзаказа.",
"properties": {
"release_date": {
"type": [
"string",
"null"
],
"description": "Дата выпуска игры на платформе в формате ISO 8601."
},
"is_enabled": {
"type": "boolean",
"description": "Если этот параметр отключен, товар не является предзаказом."
},
"description": {
"type": [
"string",
"null"
],
"description": "Дополнительная информация для предзаказа, которая будет выслана по электронной почте."
}
}
},
"regions": {
"$ref": "#/components/schemas/Game-Keys_regions"
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_admin-attributes"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"groups": {
"type": "array",
"example": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"description": "Группы, к которым принадлежит товар.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
},
"name": {
"type": "object",
"example": {
"en": "Horror"
}
}
}
}
}
}
}
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"items": [
{
"item_id": 1,
"sku": "com.xsolla.game_1",
"type": "unit",
"name": {
"en": "Game 1"
},
"description": {
"en": "Example game 1"
},
"long_description": {
"en": "Example game's long description"
},
"image_url": "https://image.example.com",
"media_list": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"order": 1,
"groups": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"attributes": [
{
"external_id": "platform",
"name": {
"en-US": "Platform"
},
"values": [
{
"external_id": "platform_value_d847f9a494487f5e95ad218f7beecac646f15989",
"value": {
"en-US": "Windows, Linux",
"de-DE": "Windows, Linux"
}
}
]
}
],
"is_free": false,
"is_enabled": true,
"is_show_in_store": false,
"unit_items": [
{
"item_id": 3,
"sku": "com.xsolla.game_1_key_1",
"type": "game_key",
"is_free": false,
"prices": [
{
"amount": 1199.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true,
"country_iso": "RU"
}
],
"virtual_prices": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": false,
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"drm_image": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png",
"drm_id": 1,
"keys": {
"available": 3,
"total": 4,
"used": 1
},
"is_sales_exist": false,
"pre_order": {
"release_date": null,
"is_enabled": false,
"description": null
},
"limits": {
"per_user": {
"total": 10,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 10000,
"available": 5000,
"reserved": 500,
"sold": 4500
},
"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"
}
}
},
"periods": [
{
"date_from": "2020-08-11T20:00:00+03:00",
"date_until": null
}
]
},
{
"item_id": 4,
"sku": "com.xsolla.game_1_key_2",
"type": "game_key",
"name": {
"en": "Game 1 Key 2"
},
"groups": [],
"attributes": [],
"is_free": false,
"prices": [
{
"amount": 1299.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true,
"country_iso": "RU"
}
],
"virtual_prices": null,
"order": 1,
"is_enabled": true,
"is_show_in_store": false,
"drm_name": "Epic Games Store",
"drm_sku": "epicgames_key_1",
"drm_image": null,
"drm_id": 8,
"keys": {
"available": 0,
"total": 0,
"used": 0
},
"is_sales_exist": true,
"pre_order": {
"release_date": "2020-08-11T10:00:00+03:00",
"is_enabled": true,
"description": "Some description"
},
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
}
]
},
{
"item_id": 2,
"sku": "com.xsolla.game_2",
"type": "unit",
"name": {
"en": "Game 2"
},
"description": {
"en": "Example game 2"
},
"long_description": {
"en": "Example game's long description"
},
"image_url": "https://image.example.com",
"media_list": [],
"order": 1,
"groups": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"attributes": [
{
"external_id": "platform",
"name": {
"en-US": "Platform"
},
"values": [
{
"external_id": "platform_value_d847f9a494487f5e95ad218f7beecac646f15989",
"value": {
"en-US": "Windows, Linux",
"de-DE": "Windows, Linux"
}
}
]
}
],
"is_free": false,
"is_enabled": true,
"is_show_in_store": true,
"unit_items": [
{
"item_id": 5,
"sku": "com.xsolla.game_2_key_2",
"type": "game_key",
"is_free": false,
"prices": [],
"virtual_prices": [
{
"sku": "com.xsolla.gold_1",
"name": {
"en": "Gold"
},
"type": "virtual_currency",
"description": null,
"image_url": "https://i.pinimg.com/originals/91/ae/56/91ae5683045f6dbef16b1482bade938f.png",
"amount": 1000,
"is_default": true
}
],
"order": 1,
"is_enabled": false,
"is_show_in_store": false,
"drm_name": "Epic Games Store",
"drm_sku": "epicgames_key_1",
"drm_image": null,
"drm_id": 8,
"keys": {
"available": 0,
"total": 0,
"used": 0
},
"is_sales_exist": true,
"pre_order": {
"release_date": null,
"is_enabled": false,
"description": null
},
"limits": {
"per_user": {
"total": 10,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 10000,
"available": 5000,
"reserved": 500,
"sold": 4500
},
"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"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
]
}
]
}
}
}
}
}
},
"Game-Keys_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"
}
}
}
}
}
},
"Game-Keys_422-invalid-request": {
"description": "Неверный запрос.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Game-Keys_422-invalid-request"
},
"examples": {
"The property `drm_sku` is required": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `drm_sku` is required"
}
},
"Numbers of attribute values per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attribute-values-per-item-exceeded"
},
"Numbers of attributes per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attributes-per-item-exceeded"
},
"Value limit exceeded": {
"$ref": "#/components/examples/422-value-limit-exceeded"
}
}
}
}
},
"Game-Keys_200-admin-get-game-by-sku": {
"description": "Игра успешно получена.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Объект с информацией об игре.",
"properties": {
"item_id": {
"type": "integer",
"example": 1,
"description": "Внутренний уникальный ID товара, который задается при создании товара."
},
"sku": {
"type": "string",
"example": "game_1",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"type": {
"type": "string",
"example": "unit",
"description": "Тип товара. В данном случае это всегда `unit`."
},
"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": {
"type": "string",
"example": "https://image.example.com",
"description": "URL-адрес изображения."
},
"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": "Приоритет порядка игры в списке."
},
"groups": {
"type": "array",
"example": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"description": "Группы, к которым принадлежит товар.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
},
"name": {
"type": "object",
"example": {
"en": "Horror"
}
}
}
}
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_admin-attributes"
},
"is_enabled": {
"type": "boolean"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_show_in_store": {
"type": "boolean"
},
"unit_items": {
"type": "array",
"description": "Платформы публикации игры.",
"items": {
"type": "object",
"description": "Игра, опубликованная на определенной платформе (steam, gog и т.д.).",
"properties": {
"item_id": {
"type": "integer",
"example": 1,
"description": "Внутренний уникальный ID товара, который задается при создании товара."
},
"sku": {
"type": "string",
"example": "game_1",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"type": {
"type": "string",
"example": "game_key",
"description": "Тип товара. В данном случае это всегда `game_key`."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"prices": {
"type": "array",
"description": "Цены в реальных валютах.",
"example": [
{
"amount": 1299.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true,
"country_is": "RU"
}
],
"items": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"example": 1299.99
},
"currency": {
"type": "string",
"example": "RUB",
"description": "Валюта, в которой указана цена товара. Трехбуквенный код в соответствии со стандартом [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
},
"is_default": {
"type": "boolean",
"description": "Цена по умолчанию используется для построения каталога, если цена в валюте пользователя не указана."
},
"is_enabled": {
"type": "boolean"
},
"country_iso": {
"type": [
"string",
"null"
],
"example": "US",
"description": "Страна, где доступна эта цена. Двухбуквенный код в соответствии с [ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)."
}
}
}
},
"virtual_prices": {
"type": [
"array",
"null"
],
"example": [
{
"sku": "com.xsolla.gold_1",
"name": {
"en": "Gold"
},
"type": "virtual_currency",
"description": null,
"image_url": "https://i.pinimg.com/originals/91/ae/56/91ae5683045f6dbef16b1482bade938f.png",
"amount": 1000,
"is_default": true
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "gold",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"name": {
"type": "object",
"additionalProperties": true,
"example": {
"en": "Gold"
},
"description": "Объект с локализациями для названия виртуальной валюты. Ключи для обозначения стран указаны в стандарте ISO 3166-1."
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "Тип товара. В данном случае это всегда `virtual_currency`."
},
"description": {
"type": "object",
"additionalProperties": true,
"example": {
"en": "Game 1 Example"
},
"description": "Объект с локализациями для описания игры. Игровые ключи для обозначения стран указаны в стандарте ISO 3166-1."
},
"image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "URL-адрес изображения."
},
"amount": {
"type": "number"
},
"is_default": {
"type": "boolean"
}
}
}
},
"order": {
"type": "integer",
"example": 1,
"description": "Приоритет порядка игры в списке."
},
"is_enabled": {
"type": "boolean",
"description": "Если этот параметр отключен, товар нельзя приобрести и получить к нему доступ через инвентарь."
},
"is_show_in_store": {
"type": "boolean",
"description": "Товар доступен для покупки."
},
"drm_name": {
"type": "string",
"example": "Steam",
"description": "Название игры на платформе."
},
"drm_sku": {
"type": "string",
"example": "steam",
"description": "Уникальный ID платформы."
},
"drm_image": {
"type": [
"string",
"null"
],
"example": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png",
"description": "Значок игры на платформе."
},
"drm_id": {
"type": "integer",
"example": 1,
"description": "Внутренний уникальный ID платформы."
},
"keys": {
"type": "object",
"properties": {
"available": {
"type": "integer",
"description": "Количество игровых ключей, доступных для покупки."
},
"total": {
"type": "integer",
"description": "Общее количество загруженных игровых ключей."
},
"used": {
"type": "integer",
"description": "Количество проданных игровых ключей."
}
}
},
"is_sales_exist": {
"type": "boolean",
"description": "Если `true`, зафиксированы продажи игры на данной платформе."
},
"pre_order": {
"type": "object",
"description": "Настройки предзаказа.",
"properties": {
"release_date": {
"type": [
"string",
"null"
],
"description": "Дата выпуска игры на платформе в формате ISO 8601."
},
"is_enabled": {
"type": "boolean",
"description": "Если этот параметр отключен, товар не является предзаказом."
},
"description": {
"type": [
"string",
"null"
],
"description": "Дополнительная информация для предзаказа, которая будет выслана по электронной почте."
}
}
},
"regions": {
"$ref": "#/components/schemas/Game-Keys_regions"
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"item_id": 1,
"sku": "com.xsolla.game_1",
"type": "unit",
"name": {
"en": "Game 1"
},
"description": {
"en": "Example game 1"
},
"long_description": {
"en": "Example game's long description"
},
"image_url": "https://image.example.com",
"media_list": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"order": 1,
"groups": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"attributes": [
{
"external_id": "platform",
"name": {
"en-US": "Platform"
},
"values": [
{
"external_id": "platform_value_d847f9a494487f5e95ad218f7beecac646f15989",
"value": {
"en-US": "Windows, Linux",
"de-DE": "Windows, Linux"
}
}
]
}
],
"is_free": false,
"is_enabled": true,
"is_show_in_store": false,
"unit_items": [
{
"item_id": 3,
"sku": "com.xsolla.game_1_key_1",
"type": "game_key",
"is_free": false,
"prices": [
{
"amount": 1199.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true,
"country_iso": "RU"
}
],
"virtual_prices": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": false,
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"drm_image": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png",
"drm_id": 1,
"keys": {
"available": 3,
"total": 4,
"used": 1
},
"is_sales_exist": false,
"pre_order": {
"release_date": null,
"is_enabled": false,
"description": null
},
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 10000,
"available": 5000,
"reserved": 500,
"sold": 4500
},
"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"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"item_id": 4,
"sku": "com.xsolla.game_1_key_2",
"type": "game_key",
"is_free": false,
"prices": [
{
"amount": 1299.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true,
"country_iso": "RU"
}
],
"virtual_prices": null,
"order": 1,
"is_enabled": true,
"is_show_in_store": false,
"drm_name": "Epic Games Store",
"drm_sku": "epicgames_key_1",
"drm_image": null,
"drm_id": 8,
"keys": {
"available": 0,
"total": 0,
"used": 0
},
"is_sales_exist": false,
"pre_order": {
"release_date": "2020-08-11T10:00:00+03:00",
"is_enabled": true,
"description": null
},
"regions": [
{
"id": 12
},
{
"id": 64
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
]
}
}
}
}
}
},
"Game-Keys_200-session-information": {
"description": "Информация о сеансе загрузки кодов успешно получена.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"session_id": {
"type": "string",
"example": "fc7105b6e8ee01339582970b37697242"
},
"count_uploaded": {
"type": "integer",
"example": 0
},
"count_total": {
"type": "integer",
"example": 100
},
"count_skipped": {
"type": "integer",
"example": 10
},
"status": {
"type": "string",
"example": "processing"
}
}
},
"examples": {
"response": {
"value": {
"session_id": "fc7105b6e8ee01339582970b37697242",
"count_uploaded": 0,
"count_total": 100,
"count_skipped": 10,
"status": "processing"
}
}
}
}
}
},
"Game-Keys_200-get-codes": {
"description": "Коды успешно получены.",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "PIN-CODE-ALL PIN-CODE-ALL-3"
},
"examples": {
"response": {
"value": "PIN-CODE-ALL PIN-CODE-ALL-3"
}
}
}
}
},
"Game-Keys_200-user-entitlement-list": {
"description": "Список игровых ключей, принадлежащих пользователю, успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Объект с информацией об игре.",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"total_items_count": {
"$ref": "#/components/schemas/Pagination_total-items-count"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Game-Keys_entitlement_item"
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": false,
"total_items_count": 1,
"items": [
{
"name": "The Greatest Game in the World",
"description": "Description of the greatest game in the world.",
"image_url": "https://none",
"project_id": 30810,
"game_sku": "com.xsolla.key_1",
"drm": "drmfree",
"is_pre_order": false
}
]
}
}
}
}
}
},
"Game-Keys_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"
}
}
}
}
}
},
"Bundles_200-admin-get-bundle-list": {
"description": "Список бандлов успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Объект с товарами.",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bundles_admin_bundle_response"
}
}
}
},
"example": {
"items": [
{
"item_id": 610316,
"sku": "com.xsolla.UltraSuperLootboxBundle_1",
"name": {
"en": "Ultra Super Lootbox Bundle"
},
"type": "bundle",
"description": {
"en": "Ultra Super Lootbox with items"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/779d2588a5b3cf348133fa7d5755cec8.png",
"long_description": {
"en": "Ultra Super lootbox with different items"
},
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
}
],
"prices": [
{
"amount": "150.49",
"currency": "USD",
"is_default": true,
"is_enabled": true
}
],
"virtual_prices": [],
"media_list": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "standard",
"content": [
{
"sku": "com.xsolla.booster_min_1",
"name": {
"en": "Xsolla Booster Mini"
},
"type": "virtual_good",
"description": {
"en": "Test your luck to find glorious treasures from the past in an Xsolla Booster Mini."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5ee252b292a560930c8f7e2c791dfc6d.png",
"quantity": 2
},
{
"sku": "com.xsolla.booster_min_2",
"name": {
"en": "Booster"
},
"type": "virtual_good",
"description": {
"en": "Get high-quality, competitively priced gas with Booster. Download the app for free same-day delivery. Kick the gas station habit for good."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/e76d317ee5a8d06a4b730bcf23746e9e.png",
"quantity": 15
},
{
"sku": "com.xsolla.gloves_1",
"name": {
"en": "Xsolla Gloves"
},
"type": "virtual_good",
"description": {
"en": "Enjoy a range of outdoor activities with gloves from EK Sporting Goods."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/93a7ee3ae284b677d3dc1f2e989731cb.png",
"quantity": 3
},
{
"sku": "com.xsolla.boots_1",
"name": {
"en": "Xsolla Boots"
},
"type": "virtual_good",
"description": {
"en": "Stylishly protect your toes with the accent of Xsolla"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/6e33d40df3cdac152dac9ac3d1f5986e.png",
"quantity": 2
},
{
"sku": "com.xsolla.gun_max",
"name": {
"en": "Xsolla Gun"
},
"type": "virtual_good",
"description": {
"en": "The M134 Minigun is a 7.62×51mm NATO, six-barrel rotary machine gun with a high rate of fire (2,000 to 6,000 rounds per minute)"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/3093eeb39d5ec7def3af6396607a30ba.png",
"quantity": 10
},
{
"sku": "com.xsolla.minigun_2",
"name": {
"en": "Empire Minigun"
},
"type": "virtual_good",
"description": {
"en": "Just hold down the trigger and pray to the Empire"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/dabfa4567cd2d82e0562d4b0f448b436.png",
"quantity": 3
}
],
"limits": {
"per_user": {
"total": 10,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677639600,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-03-01T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"type": "lootbox",
"purchased": 0
}
},
{
"item_id": 610317,
"sku": "com.xsolla.EmpireBundle_1",
"name": {
"en": "Empire bundle"
},
"type": "bundle",
"description": {
"en": "Empire bundle with items"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png",
"long_description": {
"en": "Empire bundle with some goods"
},
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
}
],
"prices": [],
"virtual_prices": [
{
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"amount": "150",
"is_default": true
}
],
"media_list": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "standard",
"content": [
{
"sku": "com.xsolla.keys_2",
"name": {
"en": "Empire Key"
},
"type": "virtual_good",
"description": {
"en": "Opens ONE Empire lootbox of any kind"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c2f8536f08a9949964e4fa2e01a7cb8.png",
"quantity": 5
},
{
"sku": "com.xsolla.booster_mega_2",
"name": {
"en": "Empire Booster Mega"
},
"type": "virtual_good",
"description": {
"en": "Take it, take it all! All of the Empires riches in one Mega Booster."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/55e908cb9670301ac8f89a6382433a27.png",
"quantity": 1
},
{
"sku": "com.xsolla.booster_min_2",
"name": {
"en": "Empire Booster Mini"
},
"type": "virtual_good",
"description": {
"en": "Test your luck to find glorious treasures from Empire's past"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5bcecec17400a0d8c72dd265ff730b07.png",
"quantity": 3
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
}
]
}
}
}
},
"Bundles_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"
}
}
}
}
}
},
"Bundles_201-admin-create-bundle": {
"description": "Бандл успешно создан.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
}
}
},
"examples": {
"response": {
"value": {
"sku": "com.xsolla.kg_1"
}
}
}
}
}
},
"Bundles_422-invalid-request": {
"description": "Неверный запрос.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Bundles_422-invalid-request"
},
"examples": {
"The property `sku` is required": {
"$ref": "#/components/examples/422-property-sku-is-required"
},
"Numbers of attribute values per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attribute-values-per-item-exceeded"
},
"Numbers of attributes per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attributes-per-item-exceeded"
},
"Value limit exceeded": {
"$ref": "#/components/examples/422-value-limit-exceeded"
},
"Custom attributes JSON can’t exceed 500 characters": {
"$ref": "#/components/examples/422-custom-attributes-size-exceeded"
}
}
}
}
},
"Bundles_200-admin-get-bundle-list-in-group": {
"description": "Список бандлов успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Объект с товарами.",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bundles_admin_bundle_response"
}
}
}
},
"example": {
"items": [
{
"item_id": 610316,
"sku": "com.xsolla.UltraSuperLootboxBundle_1",
"name": {
"en": "Ultra Super Lootbox Bundle"
},
"type": "bundle",
"description": {
"en": "Ultra Super Lootbox with items"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/779d2588a5b3cf348133fa7d5755cec8.png",
"long_description": {
"en": "Ultra Super lootbox with different items"
},
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
}
],
"prices": [
{
"amount": "150.49",
"currency": "USD",
"is_default": true,
"is_enabled": true
}
],
"virtual_prices": [],
"media_list": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "standard",
"content": [
{
"sku": "com.xsolla.booster_min_1",
"name": {
"en": "Xsolla Booster Mini"
},
"type": "virtual_good",
"description": {
"en": "Test your luck to find glorious treasures from the past in an Xsolla Booster Mini."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5ee252b292a560930c8f7e2c791dfc6d.png",
"quantity": 2
},
{
"sku": "com.xsolla.booster_min_2",
"name": {
"en": "Booster"
},
"type": "virtual_good",
"description": {
"en": "Get high-quality, competitively priced gas with Booster. Download the app for free same-day delivery. Kick the gas station habit for good."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/e76d317ee5a8d06a4b730bcf23746e9e.png",
"quantity": 15
},
{
"sku": "com.xsolla.gloves_1",
"name": {
"en": "Xsolla Gloves"
},
"type": "virtual_good",
"description": {
"en": "Enjoy a range of outdoor activities with gloves from EK Sporting Goods."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/93a7ee3ae284b677d3dc1f2e989731cb.png",
"quantity": 3
},
{
"sku": "com.xsolla.boots_1",
"name": {
"en": "Xsolla Boots"
},
"type": "virtual_good",
"description": {
"en": "Stylishly protect your toes with the accent of Xsolla"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/6e33d40df3cdac152dac9ac3d1f5986e.png",
"quantity": 2
},
{
"sku": "com.xsolla.gun_max",
"name": {
"en": "Xsolla Gun"
},
"type": "virtual_good",
"description": {
"en": "The M134 Minigun is a 7.62×51mm NATO, six-barrel rotary machine gun with a high rate of fire (2,000 to 6,000 rounds per minute)"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/3093eeb39d5ec7def3af6396607a30ba.png",
"quantity": 10
},
{
"sku": "com.xsolla.minigun_2",
"name": {
"en": "Empire Minigun"
},
"type": "virtual_good",
"description": {
"en": "Just hold down the trigger and pray to the Empire"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/dabfa4567cd2d82e0562d4b0f448b436.png",
"quantity": 3
}
],
"limits": {
"per_user": {
"total": 10,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {
"per_user": {
"interval_type": "weekly",
"day_of_week": 2,
"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-03-07T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"type": "lootbox",
"purchased": 0
}
},
{
"item_id": 610317,
"sku": "com.xsolla.EmpireBundle_1",
"name": {
"en": "Empire bundle"
},
"type": "bundle",
"description": {
"en": "Empire bundle with items"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png",
"long_description": {
"en": "Empire bundle with some goods"
},
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
}
],
"prices": [],
"virtual_prices": [
{
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"amount": "150",
"is_default": true
}
],
"media_list": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "standard",
"content": [
{
"sku": "com.xsolla.keys_2",
"name": {
"en": "Empire Key"
},
"type": "virtual_good",
"description": {
"en": "Opens ONE Empire lootbox of any kind"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c2f8536f08a9949964e4fa2e01a7cb8.png",
"quantity": 5
},
{
"sku": "com.xsolla.booster_mega_2",
"name": {
"en": "Empire Booster Mega"
},
"type": "virtual_good",
"description": {
"en": "Take it, take it all! All of the Empires riches in one Mega Booster."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/55e908cb9670301ac8f89a6382433a27.png",
"quantity": 1
},
{
"sku": "com.xsolla.booster_min_2",
"name": {
"en": "Empire Booster Mini"
},
"type": "virtual_good",
"description": {
"en": "Test your luck to find glorious treasures from Empire's past"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5bcecec17400a0d8c72dd265ff730b07.png",
"quantity": 3
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
}
]
}
}
}
},
"Bundles_200-admin-get-bundle": {
"description": "Указанный бандл получен успешно.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Bundles_admin_bundle_response"
},
"example": {
"item_id": 610316,
"sku": "com.xsolla.EmpireBundle_1",
"name": {
"en": "Empire bundle"
},
"type": "bundle",
"description": {
"en": "Empire bundle with items"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png",
"long_description": {
"en": "Empire bundle with some goods"
},
"attributes": [],
"is_free": false,
"is_paid_randomized_reward": true,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
}
],
"prices": [],
"virtual_prices": [
{
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"amount": "150",
"is_default": true
}
],
"media_list": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "standard",
"content": [
{
"sku": "com.xsolla.keys_2",
"name": {
"en": "Empire Key"
},
"type": "virtual_good",
"description": {
"en": "Opens ONE Empire lootbox of any kind"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c2f8536f08a9949964e4fa2e01a7cb8.png",
"quantity": 5
},
{
"sku": "com.xsolla.booster_mega_2",
"name": {
"en": "Empire Booster Mega"
},
"type": "virtual_good",
"description": {
"en": "Take it, take it all! All of the Empires riches in one Mega Booster."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/55e908cb9670301ac8f89a6382433a27.png",
"quantity": 1
},
{
"sku": "com.xsolla.booster_min_2",
"name": {
"en": "Empire Booster Mini"
},
"type": "virtual_good",
"description": {
"en": "Test your luck to find glorious treasures from Empire's past"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5bcecec17400a0d8c72dd265ff730b07.png",
"quantity": 3
}
],
"limits": {
"per_user": {
"total": 10,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": null
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"type": "lootbox",
"purchased": 0
}
}
}
}
},
"Bundles_204-admin-update-bundle": {
"description": "Бандл успешно обновлен.",
"content": {}
},
"Bundles_204-admin-delete-bundle": {
"description": "Бандл успешно удален.",
"content": {}
},
"Bundles_204-admin-show-bundle": {
"description": "Бандл успешно отображен.",
"content": {}
},
"Bundles_204-admin-hide-bundle": {
"description": "Бандл успешно скрыт.",
"content": {}
},
"Bundles_200-get-bundle-list": {
"description": "Список бандлов успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Объект с товарами.",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bundles_client_bundle"
}
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/Bundles_200-get-bundle-list"
}
}
}
}
},
"Cart-Payment_200-get-cart-json-model": {
"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-cart_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"
]
},
"attributes": {
"$ref": "#/components/schemas/Cart-Payment_client-attributes"
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"image_url": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string"
},
"amount_without_discount": {
"type": "string"
},
"currency": {
"type": "string"
}
},
"example": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"description": "Цена товара."
},
"virtual_item_type": {
"type": "string",
"description": "Тип товара."
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_bonus": {
"type": "boolean"
},
"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"
}
}
}
},
"promotions": {
"$ref": "#/components/schemas/Catalog_cart_promotions"
}
}
},
"examples": {
"response": {
"value": {
"cart_id": "cart_id",
"is_free": false,
"items": [
{
"attributes": [],
"description": "Take it, take it all! All of Xsollas 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,
"is_bonus": 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": [],
"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": "6150.0000000000000000",
"currency": "USD"
},
"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"
}
]
}
]
}
}
}
}
}
},
"Cart-Payment_200-fill-cart-json-model": {
"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-cart_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"
]
},
"attributes": {
"$ref": "#/components/schemas/Cart-Payment_client-attributes"
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"image_url": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string"
},
"amount_without_discount": {
"type": "string"
},
"currency": {
"type": "string"
}
},
"example": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"description": "Цена товара."
},
"virtual_item_type": {
"type": "string",
"description": "Тип товара."
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_bonus": {
"type": "boolean"
},
"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"
}
}
}
},
"promotions": {
"$ref": "#/components/schemas/Catalog_cart_promotions"
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"cart_id": "cart_id",
"is_free": false,
"items": [
{
"attributes": [],
"description": "Take it, take it all! All of Xsollas 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,
"is_bonus": 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
}
],
"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"
}
]
}
],
"warnings": [
{
"sku": "com.xsolla.booster_mega_21",
"quantity": 1,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_2 not found"
}
],
"price": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"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"
}
]
}
]
}
}
}
}
}
},
"Cart-Payment_404-item": {
"description": "Товар не найден. Убедитесь, что верно указали `project_id` и `item_sku`.",
"content": {
"application/json": {
"schema": {
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_12222 not found"
}
},
"type": "object"
}
}
}
},
"Cart-Payment_422-non-negative-quantity": {
"description": "Количество товара должно быть неотрицательным целым числом.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "Item quantity must be non-negative integer."
},
"errorCode": {
"type": "integer",
"example": 1102
}
}
},
"examples": {
"response": {
"value": {
"errorCode": 1102,
"errorMessage": "[0401-1102]: Item quantity must be non-negative integer",
"statusCode": 422
}
}
}
}
}
},
"Cart-Payment_422-can-put-only-virtual-good-to-cart": {
"description": "Этот тип товара не может быть помещен в корзину. Выберите другой тип товара.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1421
},
"errorMessage": {
"type": "string",
"example": "This type of item cannot be put to the cart. Select another type of item."
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 422,
"errorCode": 1421,
"errorMessage": "Only Virtual Good Supported"
}
}
}
}
}
},
"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"
}
}
}
}
}
},
"Cart-Payment_422-invalid-cart": {
"description": "Недействительная корзина. Убедитесь, что корзина существует, не пуста и все товары в ней не бесплатны.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"example": 1401
},
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "[0401-1401]: Invalid cart"
}
}
},
"examples": {
"response": {
"value": {
"errorCode": 1401,
"statusCode": 422,
"errorMessage": "[0401-1401]: Invalid cart"
}
}
}
}
}
},
"Cart-Payment_404-create-order-with-item-not-found-errors": {
"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-item-by-sku-not-found"
},
"coupon not found": {
"$ref": "#/components/examples/404-coupon-not-found"
}
}
}
}
},
"Cart-Payment_422-create-order-with-item-invalid": {
"description": "Недопустимая ошибка.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"example": 1411
},
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "[0401-1411]: Invalid item"
}
}
},
"examples": {
"invalid item": {
"value": {
"errorCode": 1411,
"statusCode": 422,
"errorMessage": "[0401-1411]: Invalid item"
}
},
"code expired": {
"value": {
"errorCode": 9810,
"statusCode": 422,
"errorMessage": "[0401-9810]: Sorry, this code is expired."
}
},
"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."
}
}
}
}
}
},
"Cart-Free_200-order-created": {
"description": "Бесплатный заказ успешно создан.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"description": "ID заказа."
}
}
},
"examples": {
"response": {
"value": {
"order_id": 641
}
}
}
}
}
},
"Cart-Payment_422-invalid-item": {
"description": "Недействительный товар. Проверьте, что товар существует, не отключен, не удален и не бесплатен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"example": 1411
},
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "[0401-1411]: Invalid item"
}
}
},
"examples": {
"response": {
"value": {
"errorCode": 1411,
"statusCode": 422,
"errorMessage": "[0401-1411]: Invalid item"
}
}
}
}
}
},
"Cart-Payment_200-get-order": {
"description": "Успешный запрос заказа.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"example": 1,
"default": "Order ID.",
"description": "ID заказа."
},
"status": {
"type": "string",
"example": "paid",
"enum": [
"new",
"paid",
"done",
"canceled",
"expired"
],
"description": "Статус заказа. Подробное описание статусов приведено в разделе [Жизненный цикл заказа](https://developers.xsolla.com/ru/api/catalog/order-life-cycle)."
},
"content": {
"type": "object",
"description": "Детали заказа.",
"properties": {
"price": {
"type": "object",
"description": "Стоимость заказа.",
"properties": {
"amount": {
"type": "string",
"example": "30",
"description": "Цена заказа со скидкой."
},
"amount_without_discount": {
"type": "string",
"example": "30",
"description": "Стоимость заказа."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Валюта, в которой указана стоимость заказа. Трехбуквенный код в соответствии со стандартом [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
}
}
},
"virtual_price": {
"type": "object",
"description": "Цена заказа в виртуальной валюте.",
"properties": {
"amount": {
"type": "string",
"example": "100",
"description": "Цена заказа со скидкой."
},
"amount_without_discount": {
"type": "string",
"example": "150",
"description": "Стоимость заказа."
},
"currency": {
"type": "string",
"example": "test_vc",
"description": "Артикул виртуальной валюты, используемый в заказе."
}
}
},
"is_free": {
"type": "boolean",
"example": false,
"description": "Если `true`, заказ бесплатный."
},
"items": {
"type": "array",
"example": [
{
"sku": "com.xsolla.item_1",
"quantity": 1,
"is_free": false,
"price": {
"amount": "30",
"amount_without_discount": "30",
"currency": "USD"
}
}
],
"description": "Список товаров.",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "some_sku",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"quantity": {
"type": "integer",
"example": 1,
"description": "Количество товаров."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "Цена товара.",
"properties": {
"amount": {
"type": "string",
"example": "30",
"description": "Цена товара со скидкой."
},
"amount_without_discount": {
"type": "string",
"example": "30",
"description": "Цена товара."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Валюта, в которой указана цена товара. Трехбуквенный код в соответствии со стандартом [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
}
}
}
}
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"order_id": 1,
"status": "paid",
"content": {
"price": {
"amount": "30",
"amount_without_discount": "30",
"currency": "USD"
},
"is_free": false,
"items": [
{
"sku": "com.xsolla.item_1",
"quantity": 1,
"is_free": false,
"price": {
"amount": "30",
"amount_without_discount": "30",
"currency": "USD"
}
}
]
}
}
}
}
}
}
},
"Cart-Payment_404-get-order": {
"description": "Заказ не найден. Убедитесь, что верно указали `project_id` и `order_id`.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 9001
},
"errorMessage": {
"type": "string",
"example": "[0401-9001]: Order not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 9001,
"errorMessage": "[0401-9001]: Order not found"
}
}
}
}
}
},
"200-admin-order-search": {
"description": "Список заказов успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"orders": {
"type": "array",
"description": "Список заказов.",
"items": {
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"example": 1,
"description": "ID заказа."
},
"project_id": {
"type": "integer",
"example": 44056,
"description": "ID проекта. Вы можете найти этот параметр в [Личном кабинете](https://publisher.xsolla.com/) рядом с названием проекта."
},
"status": {
"type": "string",
"enum": [
"new",
"paid",
"done",
"canceled",
"expired"
],
"example": "paid",
"description": "Статус заказа. Подробное описание статусов приведено в разделе [Жизненный цикл заказа](https://developers.xsolla.com/ru/api/catalog/order-life-cycle)."
},
"date_created": {
"type": "string",
"format": "date-time",
"example": "2020-08-11T10:00:00+03:00",
"description": "Дата или дата и время создания заказа согласно стандарту [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)."
},
"mode": {
"type": "string",
"enum": [
"default",
"sandbox"
],
"example": "default",
"description": "Режим создания заказа."
},
"is_free": {
"type": "boolean",
"example": false,
"description": "Является ли заказ бесплатным."
},
"invoice_id": {
"type": "string",
"description": "ID счета."
},
"price": {
"type": [
"object",
"null"
],
"description": "Стоимость заказа.",
"properties": {
"amount": {
"type": "string",
"example": "30",
"description": "Финальная стоимость заказа."
},
"amount_without_discount": {
"type": "string",
"example": "30",
"description": "Стоимость заказа без учета скидки."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Артикул виртуальной валюты или трехбуквенный код реальной валюты согласно стандарту [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Список валют, поддерживаемых Xsolla, [приведен в документации](https://developers.xsolla.com/ru/doc/pay-station/references/supported-currencies/)."
},
"is_virtual_currency": {
"type": "boolean",
"example": false,
"description": "Является ли валюта виртуальной."
}
}
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "07e653a2b15011e6818f005056a54369",
"description": "ID пользователя, переданный при создании заказа."
},
"country": {
"type": "string",
"description": "Двухбуквенное обозначение страны в верхнем регистре согласно стандарту [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Список стран, поддерживаемых Xsolla, приведен [в документации](https://developers.xsolla.com/ru/doc/shop-builder/references/supported-countries/).",
"example": "US"
},
"email": {
"type": "string",
"format": "email",
"example": "user@xsolla.com",
"description": "Email-адрес пользователя. Должен быть валидным в соответствии с протоколом [ RFC 822](https://www.w3.org/Protocols/rfc822/#z8)."
},
"region_id": {
"type": [
"integer",
"null"
],
"example": 12,
"description": "ID региона пользователя. Возвращается, если настроены региональные ограничения продаж. Страна пользователя, переданная при создании заказа, сопоставляется со списком стран, указанных при [создании региона](https://developers.xsolla.com/ru/api/shop-builder/operation/admin-create-region/). Подробную информацию о региональных ограничениях продаж читайте в [документации](https://developers.xsolla.com/ru/doc/shop-builder/features/regional-restrictions/)."
}
}
},
"items": {
"type": "array",
"description": "Список товаров.",
"items": {
"type": "object",
"properties": {
"order_item_id": {
"type": "integer",
"description": "ID товара в заказе. Генерируется на стороне Xsolla во время создания заказа."
},
"item_id": {
"type": "integer",
"example": 1,
"description": "ID товара. Генерируется на стороне Xsolla при создании товара."
},
"sku": {
"type": "string",
"example": "elven_shield",
"description": "ID товара, указанный при его создании. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "Тип товара.",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"game_key",
"physical_good",
"value_point"
]
},
"quantity": {
"type": "integer",
"example": 1,
"description": "Количество товаров."
},
"is_free": {
"type": "boolean",
"example": false,
"default": false,
"description": "Является ли товар бесплатным."
},
"is_bonus": {
"type": "boolean",
"example": false,
"description": "Является ли товар бонусным."
},
"region_id": {
"type": [
"integer",
"null"
],
"description": "ID региона, в котором товар доступен. Подробную информацию о региональных ограничениях продаж читайте в [документации](https://developers.xsolla.com/ru/doc/shop-builder/features/regional-restrictions/)."
},
"tax_category": {
"type": "string",
"example": "DG00002",
"description": "Налоговая категория."
},
"price": {
"type": [
"object",
"null"
],
"description": "Цена товара.",
"properties": {
"amount": {
"type": "string",
"example": "30",
"description": "Цена товара со скидкой."
},
"amount_without_discount": {
"type": "string",
"example": "30",
"description": "Цена товара без скидки."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Артикул виртуальной валюты или трехбуквенный код реальной валюты согласно стандарту [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Список валют, поддерживаемых Xsolla, [приведен в документации](https://developers.xsolla.com/ru/doc/pay-station/references/supported-currencies/)."
},
"is_virtual_currency": {
"type": "boolean",
"example": false,
"description": "Является ли валюта виртуальной."
}
}
},
"description": {
"type": [
"object",
"null"
],
"description": "Объект с информацией о товаре.",
"properties": {
"name": {
"type": "string",
"description": "Название товара."
},
"image_url": {
"type": "string",
"format": "uri",
"description": "URL-адрес изображения товара."
},
"description": {
"type": "string",
"description": "Описание товара."
}
}
}
}
}
},
"promotions": {
"type": [
"array",
"null"
],
"description": "Список акций, примененных к заказу.",
"items": {
"type": "object",
"properties": {
"promotion_id": {
"type": "integer",
"example": 111425,
"description": "ID акции в рамках проекта."
}
}
}
},
"coupons": {
"type": [
"array",
"null"
],
"description": "Список купонов, примененных к заказу.",
"items": {
"type": "object",
"properties": {
"coupon_id": {
"type": "integer",
"description": "ID купона, сгенерированный на стороне Xsolla при создании акции с купоном."
},
"sku": {
"type": "string",
"description": "Артикул купона, сгенерированный на стороне Xsolla при создании акции с купоном."
},
"code": {
"type": "string",
"description": "Используемый код купона. Уникальный код, чувствительный к регистру. Содержит буквы и цифры."
},
"type": {
"type": "string",
"enum": [
"unique_catalog_offer",
"coupon",
"promocode"
],
"description": "Тип купона."
}
}
}
}
}
}
},
"total_items_count": {
"type": "integer",
"example": 1,
"description": "Общее количество заказов за указанный период времени."
},
"has_more": {
"type": "boolean",
"example": true,
"description": "Есть ли дополнительные страницы."
}
}
},
"examples": {
"response": {
"value": {
"orders": [
{
"order_id": 100511,
"project_id": 101,
"status": "done",
"date_created": "2018-01-08T15:32:06+03:00",
"mode": "default",
"user": {
"id": "07e653a2b15011e6818f005056a54369",
"country": "US",
"email": "user@xsolla.com",
"region_id": 1
},
"is_free": true,
"items": [
{
"order_item_id": 29,
"item_id": 1005111,
"sku": "com.xsolla.1005111",
"type": "virtual_good",
"quantity": 1,
"is_free": true,
"is_bonus": false,
"region_id": 1,
"tax_category": "DG00001",
"description": {
"name": "bla",
"image_url": "http://example.com/image.jpg",
"description": "yes"
}
},
{
"order_item_id": 30,
"item_id": 1005112,
"sku": "com.xsolla.1005112",
"type": "value_point",
"quantity": 3,
"is_free": true,
"is_bonus": true,
"region_id": 1,
"tax_category": "DG00001",
"description": null
}
]
},
{
"order_id": 100510,
"project_id": 101,
"status": "paid",
"date_created": "2018-01-07T15:32:06+03:00",
"mode": "default",
"user": {
"id": "07e653a2b15011e6818f005056a54369",
"country": "US",
"email": "user@xsolla.com",
"region_id": null
},
"is_free": false,
"items": [
{
"order_item_id": 27,
"item_id": 1005101,
"sku": "com.xsolla.1005101",
"type": "game_key",
"quantity": 1,
"is_free": false,
"is_bonus": false,
"region_id": null,
"tax_category": "DG00001",
"description": null,
"price": {
"amount": "67.3400",
"amount_without_discount": "67.3400",
"currency": "USD",
"is_virtual_currency": false
}
},
{
"order_item_id": 28,
"item_id": 1005102,
"sku": "com.xsolla.1005102",
"type": "value_point",
"quantity": 2,
"is_free": true,
"is_bonus": true,
"region_id": null,
"tax_category": "DG00001",
"description": null
}
],
"price": {
"amount": "67.3400",
"amount_without_discount": "72.3400",
"currency": "USD",
"is_virtual_currency": false
},
"invoice_id": "100510",
"promotions": [
{
"promotion_id": 1005101
}
],
"coupons": [
{
"coupon_id": 100510,
"sku": "com.xsolla.100510",
"code": "OPQRSTUVWX",
"type": "promocode"
}
]
},
{
"order_id": 100505,
"project_id": 101,
"status": "paid",
"date_created": "2018-01-02T15:32:06+03:00",
"mode": "default",
"user": {
"id": "07e653a2b15011e6818f005056a54369",
"country": "US",
"email": "user@xsolla.com",
"region_id": null
},
"is_free": false,
"items": [
{
"order_item_id": 17,
"item_id": 1005051,
"sku": "com.xsolla.1005051",
"type": "virtual_good",
"quantity": 1,
"is_free": true,
"is_bonus": true,
"region_id": null,
"tax_category": "DG00001",
"description": null
},
{
"order_item_id": 18,
"item_id": 1005052,
"sku": "com.xsolla.1005052",
"type": "value_point",
"quantity": 3,
"is_free": true,
"is_bonus": true,
"region_id": null,
"tax_category": "DG00001",
"description": null
}
],
"price": {
"amount": "78.2300",
"amount_without_discount": "78.2300",
"currency": "popugi",
"is_virtual_currency": true
}
}
],
"total_items_count": 11,
"has_more": true
}
}
}
}
}
},
"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"
}
}
}
}
}
},
"Cart-Payment_201-admin-create-payment-token": {
"description": "Платежный токен и заказ успешно созданны.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"token": {
"type": "string",
"description": "Платежный токен."
},
"order_id": {
"type": "integer",
"example": 1,
"description": "ID заказа."
}
}
},
"examples": {
"response": {
"value": {
"token": "huooAqbXBSJxB8Q4dYBqJp4ybiInqsPb",
"order_id": 12345
}
}
}
}
}
},
"Cart-Payment_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"
}
}
}
}
}
},
"Cart-Payment_422-admin-create-payment-token": {
"description": "Ошибка в теле запроса или на этапе создания корзины.\n - Нельзя наполнить корзину переданными товарами. Проверяет, что корзина не пуста и что все товары не бесплатны.\n - Неверное тело запроса.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/422-invalid-request"
},
"examples": {
"Invalid request body": {
"value": {
"errorCode": 1102,
"statusCode": 422,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `name` is required",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"Item is free": {
"value": {
"errorCode": 1421,
"statusCode": 422,
"errorMessage": "[0401-1421]: Item is free",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"Invalid cart": {
"value": {
"errorCode": 1401,
"statusCode": 422,
"errorMessage": "[0401-1401]: Invalid cart",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"Empty cart": {
"value": {
"errorCode": 1417,
"statusCode": 422,
"errorMessage": "[0401-1417]: Empty cart! Cart shouldn't be empty!",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"User country not provided": {
"value": {
"errorCode": 1102,
"statusCode": 422,
"errorMessage": "[0401-1102]: The parameter user.country.value or the header X-User-Ip must be specified",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
}
}
}
}
},
"Cart-Payment_200-admin-fill-cart-json-model": {
"description": "Корзина с товарами успешно возвращена.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cart_id": {
"type": "string",
"example": "cart_id",
"description": "ID корзины. Передается в виде параметра запроса к прокси-странице или в виде параметра пути в API методах оплаты."
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string"
},
"amount_without_discount": {
"type": "string"
},
"currency": {
"type": "string"
}
},
"description": "Цена корзины."
},
"is_free": {
"$ref": "#/components/schemas/value-cart_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"
]
},
"attributes": {
"$ref": "#/components/schemas/Cart-Payment_client-attributes"
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"image_url": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_bonus": {
"type": "boolean"
},
"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"
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string"
},
"amount_without_discount": {
"type": "string"
},
"currency": {
"type": "string"
}
},
"description": "Цена товара."
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
}
}
}
},
"promotions": {
"$ref": "#/components/schemas/Catalog_cart_promotions"
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"cart_id": "cart_id",
"is_free": false,
"items": [
{
"attributes": [],
"description": "The cup of tea",
"groups": [
{
"external_id": "cups",
"name": "Cups"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": false,
"is_bonus": false,
"name": "Cup",
"price": {
"amount": "5.99",
"amount_without_discount": "5.99",
"currency": "USD"
},
"quantity": 2,
"sku": "com.xsolla.cup01",
"type": "physical_good",
"virtual_prices": [],
"promotions": [],
"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"
}
]
},
{
"attributes": [],
"description": "Wonderful white T-shirt",
"groups": [],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": false,
"is_bonus": false,
"name": "White T-shirt",
"price": {
"amount": "3.99",
"amount_without_discount": "4.99",
"currency": "USD"
},
"quantity": 1,
"sku": "com.xsolla.t-shirt01",
"type": "physical_good",
"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": [],
"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": "Wonderful white T-shirt",
"groups": [
{
"external_id": "clothes",
"name": "Clothes"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": true,
"is_bonus": false,
"name": "Cat's cup",
"price": null,
"quantity": 1,
"sku": "com.xsolla.cup01",
"type": "physical_good",
"virtual_prices": [],
"promotions": [],
"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": [],
"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"
}
]
}
],
"warnings": [
{
"sku": "com.xsolla.hat01",
"quantity": 1,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with Project Id = 44056 and Sku = hut01 not found"
}
],
"price": {
"amount": "15.97",
"amount_without_discount": "22.96",
"currency": "USD"
},
"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"
}
]
}
]
}
}
}
}
}
},
"Cart-Payment_404-user": {
"description": "Пользователь не найден. Убедитесь, что верно указали токен `x-user-for` или `x-user-id`.",
"content": {
"application/json": {
"schema": {
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 5008
},
"errorMessage": {
"type": "string",
"example": "[0401-5008]: Could not find User"
}
},
"type": "object"
}
}
}
},
"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-item-limits": {
"description": "Ограничения на покупку для пользователя были успешно получены.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User-limit-item"
},
"examples": {
"response": {
"value": {
"per_user": {
"total": 10,
"available": 9
}
}
}
}
}
}
},
"connector-422-validation-failed": {
"description": "Ошибка валидации, вызванная некорректными параметрами тела запроса, свойствами файла или содержимым файла.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"example": 1803
},
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "[0410-1803]: File content-type doesn't allowed. Allowed content types: application/json; current content type: text/plain"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 422,
"errorCode": 1803,
"errorMessage": "[0410-1803]: File content-type doesn't allowed. Allowed content types: application/json; current content type: text/plain",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"200-items-import-status-model": {
"description": "Статус импорта успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"example": "error",
"description": "Статус импорта.\n\nСтатус импорта:\n- `initialized` — Импорт запущен.\n- `process` — Импорт в процессе.\n- `done` — Импорт успешно завершен.\n- `error` — Из-за ошибок импорт не был выполнен или был выполнен частично.",
"enum": [
"initialized",
"process",
"done",
"error"
]
},
"date_created": {
"type": "string",
"example": "2024-12-15T18:16:00+03:00",
"description": "Дата и время создания операции импорта по часовому поясу GMT+3."
},
"date_updated": {
"type": "string",
"example": "2024-12-15T18:16:00+03:00",
"description": "Дата и время, когда импорт был прерван из-за возникшей ошибки по часовому поясу GMT+3."
},
"date_completed": {
"type": "string",
"example": "2024-12-15T18:16:00+03:00",
"description": "Дата и время завершения операции импорта. Если импорт был прерван из-за ошибки и не было импортировано ни одного товара, будет передана пустая строка."
},
"progress": {
"type": "integer",
"example": 100,
"description": "Прогресс выполнения импорта в процентах."
},
"error": {
"type": "string",
"description": "Описание общей ошибки при импорте."
},
"error_code": {
"type": "string",
"description": "Код общей ошибки при импорте."
},
"result": {
"type": "object",
"description": "Объект с данными о результатах импорта и ошибках импорта по конкретным товарам.",
"properties": {
"errors_count": {
"type": "integer",
"example": 3,
"description": "Количество товаров, при импорте которых возникли ошибки."
},
"total_entities_count": {
"type": "integer",
"example": 11,
"description": "Общее количество импортируемых товаров."
},
"errors_by_sku": {
"type": "array",
"description": "Массив объектов с данными об ошибках импорта по конкретным товарам.",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "sku_1",
"description": "Артикул импортируемого товара."
},
"type": {
"type": "string",
"example": "vi",
"description": "Тип товара.",
"enum": [
"virtual_good",
"virtual_currency",
"virtual_currency_packages",
"bundle"
]
},
"error_code": {
"type": "integer",
"example": 1001,
"description": "Код ошибки импорта для конкретного артикула товара."
},
"error_message": {
"type": "string",
"example": "Something went wrong",
"description": "Описание ошибки импорта для конкретного артикула товара."
}
}
}
}
}
}
},
"example": {
"status": "error",
"date_created": "2024-11-19T14:27:31+03:00",
"date_updated": "2024-11-19T15:27:31+03:00",
"date_completed": "2024-11-19T15:27:31+03:00",
"progress": 100,
"error": null,
"error_code": null,
"result": {
"errors_count": 2,
"total_entities_count": 10,
"errors_by_sku": [
{
"sku": "com.xsolla.sword_1",
"type": "virtual_items",
"error_code": 4055,
"error_message": "[0401-4055]: Item default price not set"
},
{
"sku": "",
"type": null,
"error_code": 1817,
"error_message": "[0410-1817]: SKU can't be empty"
}
]
}
}
}
}
}
},
"sellable_items_200-get-items-list": {
"description": "Список продаваемых товаров успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Объект с продаваемыми товарами.",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"example": [
{
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"type": "virtual_currency",
"name": "Gold",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"price": {
"amount": "1.00",
"amount_without_discount": "1.00",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"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
}
]
},
{
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"price": {
"amount": "0.50",
"amount_without_discount": "0.50",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"limits": null,
"vp_rewards": []
},
{
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"price": {
"amount": "0.10",
"amount_without_discount": "0.10",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"limits": null,
"vp_rewards": []
},
{
"item_id": 259768,
"sku": "com.xsolla.gold_chest_1",
"type": "bundle",
"name": "Chest of gold",
"bundle_type": "virtual_currency_package",
"description": "Chest of gold",
"image_url": "https://cdn3.xsolla.com/img/misc/images/61b8d0785093017ce1f50ebed55c42a9.png",
"price": {
"amount": "7.99",
"amount_without_discount": "7.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"type": "virtual_currency",
"name": "Gold",
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"quantity": 10
}
],
"limits": null,
"vp_rewards": []
},
{
"item_id": 259769,
"sku": "com.xsolla.silver_chest_1",
"type": "bundle",
"name": "Chest of silver",
"bundle_type": "virtual_currency_package",
"description": "Chest of silver",
"image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"quantity": 50
}
],
"limits": null,
"vp_rewards": []
},
{
"item_id": 259770,
"sku": "com.xsolla.bronze_chest_1",
"type": "bundle",
"name": "Chest of bronze",
"bundle_type": "virtual_currency_package",
"description": "Chest of bronze",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png",
"price": {
"amount": "5.99",
"amount_without_discount": "5.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259767,
"sku": "com.xsolla.bronze_2",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"quantity": 100
}
],
"limits": null,
"vp_rewards": []
},
{
"item_id": 259771,
"sku": "com.xsolla.sword_1",
"type": "virtual_good",
"name": "Sword",
"description": "Sword",
"image_url": "https://cdn3.xsolla.com/img/misc/images/a558727a420cad609556e4449b9ecb12.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_2",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_2",
"name": "Silver",
"type": "virtual_currency",
"amount": 5,
"amount_without_discount": 5,
"calculated_price": {
"amount": "5.00",
"amount_without_discount": "5.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_2",
"name": "Bronze",
"type": "virtual_currency",
"amount": 50,
"amount_without_discount": 50,
"calculated_price": {
"amount": "50.00",
"amount_without_discount": "50.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords"
}
],
"virtual_item_type": "non_consumable",
"limits": null,
"vp_rewards": []
},
{
"item_id": 259772,
"sku": "com.xsolla.saber_1",
"type": "virtual_good",
"name": "Saber",
"description": "Saber",
"image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png",
"price": {
"amount": "3.99",
"amount_without_discount": "3.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_3",
"name": "Gold",
"type": "virtual_currency",
"amount": 3,
"amount_without_discount": 3,
"calculated_price": {
"amount": "3.00",
"amount_without_discount": "3.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_3",
"name": "Silver",
"type": "virtual_currency",
"amount": 7,
"amount_without_discount": 7,
"calculated_price": {
"amount": "7.00",
"amount_without_discount": "7.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_3",
"name": "Bronze",
"type": "virtual_currency",
"amount": 70,
"amount_without_discount": 70,
"calculated_price": {
"amount": "70.00",
"amount_without_discount": "70.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords"
}
],
"virtual_item_type": "non_consumable",
"limits": null,
"vp_rewards": []
},
{
"item_id": 259773,
"sku": "com.xsolla.bow_1",
"type": "virtual_good",
"name": "Bow",
"description": "Bow",
"image_url": "https://cdn3.xsolla.com/img/misc/images/3bb3b0a5254ad15134c891108898363f.png",
"price": {
"amount": "4.99",
"amount_without_discount": "4.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_4",
"name": "Gold",
"type": "virtual_currency",
"amount": 5,
"amount_without_discount": 5,
"calculated_price": {
"amount": "5.00",
"amount_without_discount": "5.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_4",
"name": "Silver",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_4",
"name": "Bronze",
"type": "virtual_currency",
"amount": 100,
"amount_without_discount": 100,
"calculated_price": {
"amount": "100.00",
"amount_without_discount": "100.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "bows",
"name": "Bows"
}
],
"virtual_item_type": "non_consumable",
"limits": null,
"vp_rewards": []
},
{
"item_id": 259774,
"sku": "com.xsolla.electric_shield_1",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_5",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_5",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_5",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259775,
"sku": "com.xsolla.royal_shield_1",
"type": "virtual_good",
"name": "Royal shield",
"description": "Royal shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_6",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_6",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_6",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_1",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_7",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_7",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_7",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259777,
"sku": "com.xsolla.wooden_helmet_1",
"type": "virtual_good",
"name": "Wooden helmet",
"description": "Wooden helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png",
"price": {
"amount": "0.99",
"amount_without_discount": "0.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_8",
"name": "Gold",
"type": "virtual_currency",
"amount": 1,
"amount_without_discount": 1,
"calculated_price": {
"amount": "1.00",
"amount_without_discount": "1.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_8",
"name": "Silver",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_8",
"name": "Bronze",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259778,
"sku": "com.xsolla.armor_chest_1",
"type": "bundle",
"name": "Chest of armor",
"bundle_type": "standard",
"description": "Chest of armour",
"image_url": "https://cdn3.xsolla.com/img/misc/images/5212202f9b8c9dbd254652d6cbeba03e.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_9",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_9",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_9",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"total_content_price": {
"amount": "11.98",
"amount_without_discount": "11.98",
"currency": "USD"
},
"content": [
{
"item_id": 259774,
"sku": "com.xsolla.electric_shield_2",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_10",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_10",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_10",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_2",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_11",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_11",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_11",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
}
],
"vp_rewards": []
},
{
"item_id": 259779,
"sku": "com.xsolla.treasure_chest_1",
"type": "bundle",
"name": "Treasure Chest",
"bundle_type": "standard",
"description": "Treasure Chest",
"image_url": "https://cdn3.xsolla.com/img/misc/images/7b1c0136d91398f9ab17924deee5eeec.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_12",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_12",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_12",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"total_content_price": {
"amount": "802.89",
"amount_without_discount": "802.89",
"currency": "USD"
},
"content": [
{
"item_id": 259772,
"sku": "com.xsolla.saber_2",
"type": "virtual_good",
"name": "Saber",
"description": "Saber",
"image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png",
"price": {
"amount": "3.99",
"amount_without_discount": "3.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_13",
"name": "Gold",
"type": "virtual_currency",
"amount": 3,
"amount_without_discount": 3,
"calculated_price": {
"amount": "3.00",
"amount_without_discount": "3.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_13",
"name": "Silver",
"type": "virtual_currency",
"amount": 7,
"amount_without_discount": 7,
"calculated_price": {
"amount": "7.00",
"amount_without_discount": "7.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_13",
"name": "Bronze",
"type": "virtual_currency",
"amount": 70,
"amount_without_discount": 70,
"calculated_price": {
"amount": "70.00",
"amount_without_discount": "70.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
},
{
"item_id": 259769,
"sku": "com.xsolla.silver_chest_2",
"type": "bundle",
"name": "Chest of silver",
"bundle_type": "virtual_currency_package",
"description": "Chest of silver",
"image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259766,
"sku": "com.xsolla.silver_14",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"quantity": 50
}
],
"quantity": 10
},
{
"item_id": 259770,
"sku": "com.xsolla.bronze_chest_2",
"type": "bundle",
"name": "Chest of bronze",
"bundle_type": "virtual_currency_package",
"description": "Chest of bronze",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png",
"price": {
"amount": "5.99",
"amount_without_discount": "5.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259767,
"sku": "com.xsolla.bronze_11",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"quantity": 100
}
],
"quantity": 100
}
],
"vp_rewards": []
}
],
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"example": 259774,
"description": "Внутренний уникальный ID товара, который задается при создании товара."
},
"sku": {
"type": "string",
"example": "com.xsolla.electric_shield_1",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"name": {
"type": "string",
"example": "Electric shield",
"description": "Название товара."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"total_content_price": {
"$ref": "#/components/schemas/Bundles_total_content_price"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "Тип товара: `virtual_good`/`virtual_currency`/`bundle`/`game_key`/`physical_good`.",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"game_key",
"physical_good"
]
},
"bundle_type": {
"type": "string",
"description": "Тип бандла. Возвращается, если тип элемента является бандлом.",
"enum": [
"standard",
"virtual_currency_package"
]
},
"description": {
"type": "string",
"example": "Electric shield",
"description": "Описание товара."
},
"image_url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"description": "URL-адрес изображения."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "Цены на товар.",
"properties": {
"amount": {
"type": "string",
"example": "9.99",
"description": "Цена товара со скидкой."
},
"amount_without_discount": {
"type": "string",
"example": "9.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_with_calculated_price_response"
},
"can_be_bought": {
"type": "boolean",
"example": true,
"description": "Если `true`, пользователь может купить товар."
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"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"
]
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
},
"loyalty_rewards": {
"$ref": "#/components/schemas/item-loyalty-point-reward"
},
"loyalty_prices": {
"$ref": "#/components/schemas/item-loyalty-point-prices"
},
"content": {
"type": "array",
"items": {
"type": "object",
"items": {
"$ref": "#/components/schemas/Bundles_client_content"
}
}
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"type": "virtual_currency",
"name": "Gold",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"price": {
"amount": "1.00",
"amount_without_discount": "1.00",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"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"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"limits": null,
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"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
}
],
"loyalty_prices": [
{
"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": 200
}
]
},
{
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"price": {
"amount": "0.50",
"amount_without_discount": "0.50",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"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"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"vp_rewards": [],
"loyalty_rewards": [],
"loyalty_prices": []
},
{
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"price": {
"amount": "0.10",
"amount_without_discount": "0.10",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"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"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"vp_rewards": [],
"loyalty_rewards": [],
"loyalty_prices": []
},
{
"item_id": 259768,
"sku": "com.xsolla.gold_chest_1",
"type": "bundle",
"name": "Chest of gold",
"bundle_type": "virtual_currency_package",
"description": "Chest of gold",
"image_url": "https://cdn3.xsolla.com/img/misc/images/61b8d0785093017ce1f50ebed55c42a9.png",
"price": {
"amount": "7.99",
"amount_without_discount": "7.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"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"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259765,
"sku": "com.xsolla.gold_2",
"type": "virtual_currency",
"name": "Gold",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"quantity": 10
}
],
"vp_rewards": [],
"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
}
],
"loyalty_prices": [
{
"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": 200
}
]
},
{
"item_id": 259769,
"sku": "com.xsolla.silver_chest_1",
"type": "bundle",
"name": "Chest of silver",
"bundle_type": "virtual_currency_package",
"description": "Chest of silver",
"image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"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"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259766,
"sku": "com.xsolla.silver_2",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"quantity": 50
}
],
"vp_rewards": [],
"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
}
],
"loyalty_prices": [
{
"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": 200
}
]
},
{
"item_id": 259770,
"sku": "com.xsolla.bronze_chest_1",
"type": "bundle",
"name": "Chest of bronze",
"bundle_type": "virtual_currency_package",
"description": "Chest of bronze",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png",
"price": {
"amount": "5.99",
"amount_without_discount": "5.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"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"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"quantity": 100
}
],
"vp_rewards": [],
"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
}
],
"loyalty_prices": [
{
"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": 200
}
]
},
{
"item_id": 259771,
"sku": "com.xsolla.sword_1",
"type": "virtual_good",
"name": "Sword",
"description": "Sword",
"image_url": "https://cdn3.xsolla.com/img/misc/images/a558727a420cad609556e4449b9ecb12.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_2",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_2",
"name": "Silver",
"type": "virtual_currency",
"amount": 5,
"amount_without_discount": 5,
"calculated_price": {
"amount": "5.00",
"amount_without_discount": "5.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_2",
"name": "Bronze",
"type": "virtual_currency",
"amount": 50,
"amount_without_discount": 50,
"calculated_price": {
"amount": "50.00",
"amount_without_discount": "50.00"
},
"is_default": false
}
],
"can_be_bought": true,
"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"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords",
"item_order_in_group": 1
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": [],
"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
}
],
"loyalty_prices": [
{
"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": 200
}
]
},
{
"item_id": 259772,
"sku": "com.xsolla.saber_1",
"type": "virtual_good",
"name": "Saber",
"description": "Saber",
"image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png",
"price": {
"amount": "3.99",
"amount_without_discount": "3.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_3",
"name": "Gold",
"type": "virtual_currency",
"amount": 3,
"amount_without_discount": 3,
"calculated_price": {
"amount": "3.00",
"amount_without_discount": "3.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_3",
"name": "Silver",
"type": "virtual_currency",
"amount": 7,
"amount_without_discount": 7,
"calculated_price": {
"amount": "7.00",
"amount_without_discount": "7.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_3",
"name": "Bronze",
"type": "virtual_currency",
"amount": 70,
"amount_without_discount": 70,
"calculated_price": {
"amount": "70.00",
"amount_without_discount": "70.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords",
"item_order_in_group": 2
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": [],
"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
}
],
"loyalty_prices": [
{
"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": 200
}
]
},
{
"item_id": 259773,
"sku": "com.xsolla.bow_1",
"type": "virtual_good",
"name": "Bow",
"description": "Bow",
"image_url": "https://cdn3.xsolla.com/img/misc/images/3bb3b0a5254ad15134c891108898363f.png",
"price": {
"amount": "4.99",
"amount_without_discount": "4.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_4",
"name": "Gold",
"type": "virtual_currency",
"amount": 5,
"amount_without_discount": 5,
"calculated_price": {
"amount": "5.00",
"amount_without_discount": "5.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_4",
"name": "Silver",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_5",
"name": "Bronze",
"type": "virtual_currency",
"amount": 100,
"amount_without_discount": 100,
"calculated_price": {
"amount": "100.00",
"amount_without_discount": "100.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "bows",
"name": "Bows",
"item_order_in_group": 1
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": [],
"loyalty_rewards": [],
"loyalty_prices": []
},
{
"item_id": 259774,
"sku": "com.xsolla.electric_shield_2",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_5",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_5",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_5",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 1
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": [],
"loyalty_rewards": [],
"loyalty_prices": []
},
{
"item_id": 259775,
"sku": "com.xsolla.royal_shield_2",
"type": "virtual_good",
"name": "Royal shield",
"description": "Royal shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_6",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_6",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_6",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"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"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 2
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": [],
"loyalty_rewards": [],
"loyalty_prices": []
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_1",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_7",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_7",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_7",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 3
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": [],
"loyalty_rewards": [],
"loyalty_prices": []
},
{
"item_id": 259777,
"sku": "com.xsolla.wooden_helmet_1",
"type": "virtual_good",
"name": "Wooden helmet",
"description": "Wooden helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png",
"price": {
"amount": "0.99",
"amount_without_discount": "0.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_8",
"name": "Gold",
"type": "virtual_currency",
"amount": 1,
"amount_without_discount": 1,
"calculated_price": {
"amount": "1.00",
"amount_without_discount": "1.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_8",
"name": "Silver",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_8",
"name": "Bronze",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
}
],
"can_be_bought": true,
"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"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 4
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": [],
"loyalty_rewards": [],
"loyalty_prices": []
},
{
"item_id": 259778,
"sku": "com.xsolla.armor_chest_1",
"type": "bundle",
"name": "Chest of armor",
"bundle_type": "standard",
"description": "Chest of armour",
"image_url": "https://cdn3.xsolla.com/img/misc/images/5212202f9b8c9dbd254652d6cbeba03e.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_9",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_9",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_9",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"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"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"total_content_price": {
"amount": "11.98",
"amount_without_discount": "11.98",
"currency": "USD"
},
"content": [
{
"item_id": 259774,
"sku": "com.xsolla.electric_shield_2",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_10",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_10",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_10",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"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"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_2",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_11",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_11",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_11",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"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"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
}
],
"vp_rewards": [],
"loyalty_rewards": [],
"loyalty_prices": []
},
{
"item_id": 259779,
"sku": "com.xsolla.treasure_chest_1",
"type": "bundle",
"name": "Treasure Chest",
"bundle_type": "standard",
"description": "Treasure Chest",
"image_url": "https://cdn3.xsolla.com/img/misc/images/7b1c0136d91398f9ab17924deee5eeec.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_12",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_12",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_12",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"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"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"total_content_price": {
"amount": "802.89",
"amount_without_discount": "802.89",
"currency": "USD"
},
"content": [
{
"item_id": 259772,
"sku": "com.xsolla.saber_1",
"type": "virtual_good",
"name": "Saber",
"description": "Saber",
"image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png",
"price": {
"amount": "3.99",
"amount_without_discount": "3.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_13",
"name": "Gold",
"type": "virtual_currency",
"amount": 3,
"amount_without_discount": 3,
"calculated_price": {
"amount": "3.00",
"amount_without_discount": "3.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_13",
"name": "Silver",
"type": "virtual_currency",
"amount": 7,
"amount_without_discount": 7,
"calculated_price": {
"amount": "7.00",
"amount_without_discount": "7.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_13",
"name": "Bronze",
"type": "virtual_currency",
"amount": 70,
"amount_without_discount": 70,
"calculated_price": {
"amount": "70.00",
"amount_without_discount": "70.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
},
{
"item_id": 259769,
"sku": "com.xsolla.silver_chest_2",
"type": "bundle",
"name": "Chest of silver",
"bundle_type": "virtual_currency_package",
"description": "Chest of silver",
"image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259766,
"sku": "com.xsolla.silver_13",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"quantity": 50
}
],
"quantity": 10
},
{
"item_id": 259770,
"sku": "com.xsolla.bronze_chest_2",
"type": "bundle",
"name": "Chest of bronze",
"bundle_type": "virtual_currency_package",
"description": "Chest of bronze",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png",
"price": {
"amount": "5.99",
"amount_without_discount": "5.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259767,
"sku": "com.xsolla.bronze_13",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"quantity": 100
}
],
"quantity": 100
}
],
"vp_rewards": [],
"loyalty_rewards": [],
"loyalty_prices": []
}
]
}
}
}
}
}
},
"sellable_items_200-get-item-by-id": {
"description": "Продаваемый товар успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Объект с продаваемым товаром.",
"properties": {
"item_id": {
"type": "integer",
"example": 259774,
"description": "Внутренний уникальный ID товара, который задается при создании товара."
},
"sku": {
"type": "string",
"example": "electric_shield",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"name": {
"type": "string",
"example": "Electric shield",
"description": "Название товара."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "Тип товара: `virtual_good`/`virtual_currency`/`bundle`/`game_key`/`physical_good`.",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"game_key",
"physical_good"
]
},
"description": {
"type": "string",
"example": "Electric shield",
"description": "Описание товара."
},
"image_url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"description": "URL-адрес изображения."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "Цены на товар.",
"properties": {
"amount": {
"type": "string",
"example": "9.99",
"description": "Цена товара со скидкой."
},
"amount_without_discount": {
"type": "string",
"example": "9.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_with_calculated_price_response"
},
"can_be_bought": {
"type": "boolean",
"example": true,
"description": "Если `true`, пользователь может купить товар."
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"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"
]
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
},
"loyalty_rewards": {
"$ref": "#/components/schemas/item-loyalty-point-reward"
},
"loyalty_prices": {
"$ref": "#/components/schemas/item-loyalty-point-prices"
}
}
},
"examples": {
"response": {
"value": {
"item_id": 259774,
"sku": "com.xsolla.electric_shield_1",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"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"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 10
}
],
"virtual_item_type": "non_consumable",
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"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
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"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
}
],
"loyalty_prices": [
{
"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": 200
}
]
}
}
}
}
}
},
"sellable-item-by-id_404": {
"description": "Товар не найден. Убедитесь, что верно указали `project_id` и `item_id`.",
"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 id = 259774 not found"
}
}
}
}
}
},
"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"
}
}
}
}
}
},
"sellable_items_200-get-items-by-group-id": {
"description": "Список продаваемых товаров из указанной группы успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"example": [
{
"item_id": 259774,
"sku": "com.xsolla.electric_shield_1",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"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"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"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": "clan_value_point_sku_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
},
{
"item_id": 259775,
"sku": "com.xsolla.royal_shield_1",
"type": "virtual_good",
"name": "Royal shield",
"description": "Royal shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_2",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_2",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_2",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_1",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_3",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_3",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_3",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"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"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259777,
"sku": "com.xsolla.wooden_helmet_1",
"type": "virtual_good",
"name": "Wooden helmet",
"description": "Wooden helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png",
"price": {
"amount": "0.99",
"amount_without_discount": "0.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_4",
"name": "Gold",
"type": "virtual_currency",
"amount": 1,
"amount_without_discount": 1,
"calculated_price": {
"amount": "1.00",
"amount_without_discount": "1.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_4",
"name": "Silver",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_4",
"name": "Bronze",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
}
],
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"example": 259774,
"description": "Внутренний уникальный ID товара, который задается при создании товара."
},
"sku": {
"type": "string",
"example": "com.xsolla.electric_shield_1",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"name": {
"type": "string",
"example": "Electric shield",
"description": "Название товара."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "Тип товара: `virtual_good`/`virtual_currency`/`bundle`/`game_key`/`physical_good`.",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"game_key",
"physical_good"
]
},
"description": {
"type": [
"string",
"null"
],
"example": "Electric shield",
"description": "Описание товара."
},
"image_url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"description": "URL-адрес изображения."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "Цены на товар.",
"properties": {
"amount": {
"type": "string",
"example": "9.99",
"description": "Цена товара со скидкой."
},
"amount_without_discount": {
"type": "string",
"example": "9.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_with_calculated_price_response"
},
"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"
]
},
"can_be_bought": {
"type": "boolean",
"example": true,
"description": "Если `true`, пользователь может купить товар."
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
},
"loyalty_rewards": {
"$ref": "#/components/schemas/item-loyalty-point-reward"
},
"loyalty_prices": {
"$ref": "#/components/schemas/item-loyalty-point-prices"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": true,
"items": [
{
"item_id": 259774,
"sku": "com.xsolla.electric_shields_1",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"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"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 1
}
],
"virtual_item_type": "non_consumable",
"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
}
],
"loyalty_prices": [
{
"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": 200
}
]
},
{
"item_id": 259775,
"sku": "com.xsolla.royal_shield_1",
"type": "virtual_good",
"name": "Royal shield",
"description": "Royal shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 2
}
],
"virtual_item_type": "non_consumable",
"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
}
],
"loyalty_prices": [
{
"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": 200
}
]
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_1",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_2",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_2",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_2",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"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"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 3
}
],
"virtual_item_type": "non_consumable",
"loyalty_rewards": [],
"loyalty_prices": []
},
{
"item_id": 259777,
"sku": "com.xsolla.wooden_helmet_2",
"type": "virtual_good",
"name": "Wooden helmet",
"description": "Wooden helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png",
"price": {
"amount": "0.99",
"amount_without_discount": "0.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_3",
"name": "Gold",
"type": "virtual_currency",
"amount": 1,
"amount_without_discount": 1,
"calculated_price": {
"amount": "1.00",
"amount_without_discount": "1.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_3",
"name": "Silver",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_3",
"name": "Bronze",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
}
],
"can_be_bought": true,
"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"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 4
}
],
"virtual_item_type": "non_consumable",
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
}
}
},
"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
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"loyalty_rewards": [],
"loyalty_prices": []
}
]
}
}
}
}
}
},
"200-admin-get-regions-list": {
"description": "Список регионов успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Объект с товарами.",
"properties": {
"regions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Regions_200-region-short-model"
}
}
}
},
"examples": {
"response": {
"value": {
"regions": [
{
"id": 44,
"name": {
"en-US": "Asia",
"de-DE": "Asien"
}
},
{
"id": 45,
"name": {
"en-US": "CIS",
"de-DE": "GUS"
}
}
]
}
}
}
}
}
},
"201-admin-create-region": {
"description": "Регион успешно создан.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"region_id": {
"$ref": "#/components/schemas/Regions_region_id"
}
}
},
"example": {
"region_id": 42
}
}
}
},
"200-admin-get-region": {
"description": "Указанный регион успешно получен.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Regions_200-region-model"
}
}
}
},
"404-region-not-found": {
"description": "Регион не найден. Убедитесь, что верно указали `id`.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 9701
},
"errorMessage": {
"type": "string",
"example": "[0401-9701]: Region not found"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"204-admin-update-region": {
"description": "Регион успешно обновлен.",
"content": {}
},
"204-admin-delete-region": {
"description": "Регион успешно удален.",
"content": {}
},
"200-admin-get-attribute-list-response": {
"description": "Список атрибутов успешно получен.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Объект с товарами.",
"properties": {
"attributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/admin_attribute_response"
}
},
"total_count": {
"type": "integer"
}
}
},
"examples": {
"response": {
"value": {
"total_count": 2,
"attributes": [
{
"external_id": "size",
"name": {
"en": "Size",
"de": "Größe"
}
},
{
"external_id": "genre",
"name": {
"en": "Genre",
"de": "Genre"
}
}
]
}
}
}
}
}
},
"201-admin-create-attribute": {
"description": "Атрибут успешно создан.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
}
}
},
"example": {
"external_id": "genre"
}
}
}
},
"422-validation-failed": {
"description": "Неверный запрос.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/schemas-422-invalid-request"
},
"examples": {
"response": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `external_id` is required"
}
}
}
}
}
},
"200-admin-get-attribute": {
"description": "Указанный атрибут успешно получен.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/admin_attribute_response"
}
}
}
},
"404-attribute-not-found": {
"description": "Атрибут не найден.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 9901
},
"errorMessage": {
"type": "string",
"example": "[0401-9901]: Attribute not found."
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 9901,
"errorMessage": "[0401-9901]: Attribute not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"204-admin-update-attribute": {
"description": "Атрибут успешно обновлен.",
"content": {}
},
"201-admin-create-attribute-value": {
"description": "Значение атрибута успешно создано.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
}
}
},
"example": {
"external_id": "rpg"
}
}
}
},
"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"
}
}
}
}
}
},
"422-create-update-attribute-value": {
"description": "Неверный запрос.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/schemas-422-invalid-request"
},
"examples": {
"external_id is required": {
"$ref": "#/components/examples/422-external-id-required"
},
"external_id is invalid": {
"$ref": "#/components/examples/422-external-id-invalid"
},
"external_id is duplicate": {
"$ref": "#/components/examples/422-external-id-duplicate"
},
"value is required": {
"$ref": "#/components/examples/422-value-invalid"
},
"value properties minimum length": {
"$ref": "#/components/examples/422-value-properties-required"
},
"value limit exceeded": {
"$ref": "#/components/examples/422-value-limit-exceeded"
}
}
}
}
},
"404-attribute-value-not-found": {
"description": "Значение атрибута не найдено.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404-not-found"
},
"examples": {
"Attribute not found": {
"$ref": "#/components/examples/404-attribute-not-found"
},
"Attribue value not found": {
"$ref": "#/components/examples/404-attribute-value-not-found"
}
}
}
}
}
},
"requestBodies": {
"Virtual-Items-Currency_admin-create-virtual-item": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-virtual-item"
},
"examples": {
"default": {
"summary": "Minimal setup example",
"value": {
"sku": "booster_mega_1",
"name": {
"en": "Mega Booster"
},
"description": {
"en": "Temporarily doubles the experience points earned in battle."
}
}
},
"quickstart": {
"summary": "Quickstart example",
"value": {
"sku": "booster_mega_1",
"name": {
"en": "Mega Booster",
"de": "Mega-Booster"
},
"description": {
"en": "Temporarily doubles the experience points earned in battle.",
"de": "Verdoppelt vorübergehend die im Kampf erhaltenen Erfahrungspunkte."
},
"is_enabled": true,
"is_show_in_store": true,
"is_free": false,
"groups": [
"boosters"
],
"order": 1,
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
}
]
}
},
"full-payload": {
"summary": "Full payload example",
"value": {
"sku": "com.xsolla.sword_1",
"name": {
"en": "Sword",
"de": "Schwert"
},
"is_enabled": true,
"is_free": false,
"is_paid_randomized_reward": true,
"groups": [
"weapons"
],
"order": 1,
"description": {
"en": "A sword is a bladed melee weapon intended for cutting or thrusting that is longer than a knife or dagger, consisting of a long blade attached to a hilt.",
"de": "Ein Schwert ist eine Nahkampfwaffe mit Klinge, die zum Schneiden oder Stechen bestimmt ist, länger als ein Messer oder Dolch ist und aus einer langen Klinge besteht, die an einem Griff befestigt ist."
},
"prices": [
{
"amount": 100,
"currency": "USD",
"is_enabled": true,
"is_default": true
},
{
"amount": 200,
"currency": "CZK",
"country_iso": "CZ",
"is_enabled": false,
"is_default": true
}
],
"vc_prices": [],
"is_show_in_store": true,
"attributes": [
{
"external_id": "craft-materials",
"name": {
"en": "Craft materials"
},
"values": [
{
"external_id": "steel",
"value": {
"en-US": "5"
}
},
{
"external_id": "leather",
"value": {
"en-US": "1"
}
}
]
}
],
"limits": {
"per_user": 5,
"per_item": 100
},
"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"
}
}
}
}
}
}
},
"Virtual-Items-Currency_admin-create-virtual-currency": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-virtual-currency"
},
"example": {
"sku": "com.xsolla.coin_1",
"name": {
"en-US": "Gold coin",
"de-DE": "Goldmünze"
},
"is_enabled": true,
"is_free": false,
"is_paid_randomized_reward": false,
"groups": [
"gold"
],
"order": 1,
"description": {
"en-US": "The main currency of your kingdom",
"de-DE": "Die Hauptwährung deines Königreichs"
},
"prices": [
{
"amount": 100,
"currency": "USD",
"is_enabled": true,
"is_default": true
}
],
"attributes": [
{
"external_id": "material",
"name": {
"en-US": "Material"
},
"values": [
{
"external_id": "gold",
"value": {
"en-US": "Gold"
}
}
]
}
],
"limits": {
"per_user": 5,
"per_item": 10000
},
"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"
}
}
}
}
},
"Virtual-Items-Currency_admin-create-virtual-currency-package": {
"content": {
"application/json": {
"example": {
"sku": "com.xsolla.novigrad_crown_500",
"name": {
"en-US": "500x Novigradian crown",
"ru-RU": "500x Новиградских крон"
},
"is_enabled": true,
"is_free": false,
"is_paid_randomized_reward": true,
"groups": [
"witcher"
],
"order": 1,
"long_description": {
"en-US": "Long Test new",
"ru-RU": "Длинное описание"
},
"description": {
"en-US": "The Crown (also known as the Novigradian crown) is a monetary unit which is used in some Northern Kingdoms",
"ru-RU": "Крона (Также известна как Новиградская крона) - платежная единица, используемая в северных королевствах"
},
"image_url": "https://vignette.wikia.nocookie.net/witcher/images/7/7c/Items_Orens.png/revision/latest?cb=20081113120917",
"media_list": [
{
"type": "image",
"url": "https://test.com/image0"
},
{
"type": "image",
"url": "https://test.com/image1"
}
],
"attributes": [
{
"external_id": "event",
"name": {
"en-US": "Event"
},
"values": [
{
"external_id": "10-anniversary",
"value": {
"en-US": "10th anniversary"
}
},
{
"external_id": "christmas",
"value": {
"en-US": "Christmas"
}
}
]
}
],
"prices": [
{
"currency": "USD",
"amount": 99.99,
"is_default": true
},
{
"currency": "EUR",
"amount": 80.03,
"is_enabled": false
}
],
"vc_prices": null,
"content": [
{
"sku": "com.xsolla.novigrad_crown",
"quantity": 500
}
],
"limits": {
"per_user": null,
"per_item": null
},
"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"
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-virtual-currency-package"
}
}
}
},
"ItemGroup_create": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/admin-group-create-request"
},
"example": {
"external_id": "weapons",
"name": {
"en": "Weapons",
"de": "Waffen"
},
"description": {
"en": "Player weapons",
"de": "Spielerwaffen"
},
"iconUrl": "https://example.com/weapons.png",
"isEnabled": true,
"order": 1
}
}
},
"description": "Объект с данными группы товаров.",
"required": true
},
"ItemGroup_update": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/admin-group-update-request"
},
"example": {
"external_id": "weapons",
"name": {
"en": "Weapons Updated",
"de": "Waffen Aktualisiert"
},
"description": {
"en": "Updated player weapons",
"de": "Aktualisierte Spielerwaffen"
},
"iconUrl": "https://example.com/weapons-new.png",
"isEnabled": true,
"order": 2
}
}
},
"description": "Объект с данными группы товаров для обновления.",
"required": true
},
"ItemGroup_order": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"title": "Identify by ID",
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID группы товаров, назначенный Xsolla.",
"minimum": 0,
"example": 1
},
"order": {
"type": "integer",
"description": "Новое значение порядка сортировки.",
"minimum": 0,
"example": 1
}
},
"required": [
"id",
"order"
],
"additionalProperties": false
}
},
{
"title": "Identify by external_id",
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"description": "Внешний ID группы товаров, который был указан при создании.",
"minLength": 1,
"example": "weapons"
},
"order": {
"type": "integer",
"description": "Новое значение порядка сортировки.",
"minimum": 0,
"example": 1
}
},
"required": [
"external_id",
"order"
],
"additionalProperties": false
}
}
]
},
"examples": {
"by_id": {
"summary": "Identify groups by ID",
"value": [
{
"id": 1,
"order": 1
},
{
"id": 2,
"order": 2
},
{
"id": 3,
"order": 3
}
]
},
"by_external_id": {
"summary": "Identify groups by external_id",
"value": [
{
"external_id": "weapons",
"order": 1
},
{
"external_id": "armor",
"order": 2
},
{
"external_id": "consumables",
"order": 3
}
]
}
}
}
},
"description": "Массив групп с новыми значениями порядка. Все элементы должны использовать один способ идентификации (либо все по `id`, либо все по `external_id`).",
"required": true
},
"ItemGroup_item_order": {
"content": {
"application/json": {
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/item-in-group-order-request-item"
}
},
"example": [
{
"item_id": 101,
"order": 1
},
{
"item_id": 102,
"order": 2
},
{
"item_id": 103,
"order": 3
}
]
}
},
"description": "Массив товаров с новыми значениями порядка в группе.",
"required": true
},
"Game-Keys_create-update-game-model": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"example": "game_1",
"pattern": "^[a-zA-Z0-9_\\-–.]*$",
"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"
},
"image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "URL-адрес изображения."
},
"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": "Приоритет порядка игры в списке."
},
"groups": {
"type": "array",
"description": "Группы, к которым принадлежит товар.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
}
},
"required": [
"external_id"
]
}
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_admin-post-put-attributes"
},
"is_enabled": {
"type": "boolean",
"description": "Если этот параметр отключен, товар нельзя приобрести и получить к нему доступ через инвентарь."
},
"is_show_in_store": {
"type": "boolean",
"description": "Товар доступен для покупки."
},
"unit_items": {
"type": "array",
"description": "Платформы публикации игры.",
"items": {
"type": "object",
"description": "Игра, опубликованная на определенной платформе (steam, gog и т.д.).",
"properties": {
"sku": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"example": "game_1",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"groups": {
"type": "array",
"description": "Группы, к которым принадлежит товар.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
}
},
"required": [
"external_id"
]
}
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_admin-attributes"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"prices": {
"type": "array",
"description": "Цены в реальных валютах.",
"items": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"example": 1299.99
},
"currency": {
"type": "string",
"example": "RUB",
"description": "Валюта, в которой указана цена товара. Трехбуквенный код в соответствии с [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Подробную информацию о [валютах, поддерживаемых Xsolla, смотрите в документации](https://developers.xsolla.com/ru/doc/pay-station/references/supported-currencies/)."
},
"is_default": {
"type": "boolean",
"description": "Цена по умолчанию используется для построения каталога, если цена в валюте пользователя не указана."
},
"is_enabled": {
"type": "boolean"
}
},
"required": [
"amount",
"currency",
"is_default",
"is_enabled"
]
}
},
"vc_prices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "gold",
"description": "Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания."
},
"amount": {
"type": "number"
},
"is_default": {
"type": "boolean"
},
"is_enabled": {
"type": "boolean"
}
},
"required": [
"amount",
"currency",
"is_default",
"is_enabled"
]
}
},
"order": {
"type": "integer",
"example": 1,
"description": "Приоритет порядка игры в списке."
},
"is_enabled": {
"type": "boolean",
"description": "Если этот параметр отключен, товар нельзя приобрести и получить к нему доступ через инвентарь."
},
"is_show_in_store": {
"type": "boolean",
"description": "Товар доступен для покупки."
},
"drm_sku": {
"type": "string",
"example": "steam",
"description": "Уникальный ID платформы."
},
"pre_order": {
"type": "object",
"description": "Настройки предзаказа.",
"properties": {
"release_date": {
"type": "string",
"description": "Дата выпуска игры на платформе в формате ISO 8601."
},
"is_enabled": {
"type": "boolean",
"description": "Если этот параметр отключен, товар не является предзаказом."
},
"description": {
"type": "string",
"description": "Дополнительная информация для предзаказа, которая будет выслана по электронной почте."
}
},
"required": [
"release_date",
"is_enabled"
]
},
"regions": {
"$ref": "#/components/schemas/Game-Keys_regions"
},
"limits": {
"$ref": "#/components/schemas/Game-key-item-limit"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
}
},
"required": [
"sku",
"drm_sku",
"prices"
]
}
}
},
"required": [
"sku",
"name",
"unit_items"
],
"example": {
"sku": "com.xsolla.game_1",
"name": {
"en-US": "Game name",
"ru-RU": "Название игры"
},
"description": {
"en-US": "Game description",
"ru-RU": "Краткое описание игры"
},
"long_description": {
"en-US": "Game long description",
"ru-RU": "Полное описание игры"
},
"image_url": "http://image.png",
"media_list": [
{
"type": "image",
"url": "http://image.png"
},
{
"type": "video",
"url": "http://video.png"
}
],
"groups": [
"new_games"
],
"is_enabled": true,
"is_show_in_store": true,
"unit_items": [
{
"sku": "com.xsolla.game_key_1",
"name": {
"en-US": "Game key name",
"ru-RU": "Название игрового ключа"
},
"drm_sku": "steam_key_1",
"prices": [
{
"amount": 35.5,
"currency": "USD",
"is_enabled": true,
"is_default": true
}
],
"vc_prices": [
{
"amount": 35.5,
"sku": "com.xsolla.gold_1",
"is_enabled": true,
"is_default": true
}
],
"is_enabled": true,
"is_free": false,
"is_show_in_store": true,
"pre_order": {
"release_date": "2020-08-11T10:00:00+03:00",
"is_enabled": true,
"description": "Some description"
},
"regions": [
{
"id": 12
},
{
"id": 64
}
],
"limits": {
"per_user": {
"total": 5
},
"per_item": {
"total": 10000,
"available": 5000,
"reserved": 500,
"sold": 4500
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
]
}
}
}
},
"description": "Объект с игровыми данными.",
"required": true
},
"Bundles_bundle": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Bundles_admin_bundle_request"
},
"example": {
"sku": "com.xsolla.armour_chest_1",
"name": {
"en": "Chest of armour",
"de": "Brustpanzer"
},
"is_enabled": true,
"is_free": true,
"is_paid_randomized_reward": true,
"order": 1,
"long_description": {
"en": "Chest of armour for soldiers",
"de": "Brustpanzer für Soldaten"
},
"description": {
"en": "Chest of armour for soldiers",
"de": "Brustpanzer für Soldaten"
},
"image_url": "https://picture.bundle-with-many-stuff.png",
"media_list": [
{
"type": "image",
"url": "https://test.com/image0"
},
{
"type": "image",
"url": "https://test.com/image1"
}
],
"groups": [
"chests"
],
"attributes": [
{
"external_id": "class",
"name": {
"en": "Class"
},
"values": [
{
"external_id": "soldier",
"value": {
"en": "Soldier"
}
},
{
"external_id": "officer",
"value": {
"en": "Officer"
}
}
]
}
],
"prices": [
{
"currency": "USD",
"amount": "9.99",
"is_default": true,
"is_enabled": true
},
{
"currency": "EUR",
"amount": "9.99",
"is_default": false,
"is_enabled": true
}
],
"vc_prices": [],
"content": [
{
"sku": "com.xsolla.iron_gloves_1",
"quantity": 1
},
{
"sku": "com.xsolla.iron_boots_1",
"quantity": 1
},
{
"sku": "com.xsolla.iron_shield_1",
"quantity": 1
},
{
"sku": "com.xsolla.iron_armour_1",
"quantity": 1
},
{
"sku": "com.xsolla.iron_helmet_1",
"quantity": 1
}
],
"limits": {
"per_user": null,
"per_item": null
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"type": "lootbox",
"purchased": 0
}
}
}
},
"description": "Объект с данными бандла.",
"required": true
},
"Cart-Payment_fill-cart-json-model": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"items"
],
"example": {
"items": [
{
"sku": "com.xsolla.booster_mega_1",
"quantity": 123
}
]
},
"properties": {
"items": {
"type": "array",
"description": "Список товаров.",
"items": {
"type": "object",
"minItems": 1,
"required": [
"sku",
"quantity"
],
"properties": {
"sku": {
"type": "string",
"default": "booster_mega_1"
},
"quantity": {
"type": "number",
"default": 123
}
}
}
}
}
}
}
}
},
"Cart-Payment_put-item-by-cart-idJsonModel": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"quantity": {
"type": "number",
"description": "Количество товаров.",
"default": 123
}
}
}
}
}
},
"Cart-Payment_create-order-by-cart-idJsonModel": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"description": "Валюта, в которой указана стоимость заказа. Трехбуквенный код валюты в соответствии с [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Подробную информацию о [валютах, поддерживаемых Xsolla, смотрите в документации](https://developers.xsolla.com/ru/doc/pay-station/references/supported-currencies/)."
},
"locale": {
"type": "string",
"description": "Язык ответа."
},
"sandbox": {
"type": "boolean",
"description": "Создает заказ в тестовом окружении. Эта возможность доступна для пользователей, указанных в списке пользователей компании.",
"default": false
},
"settings": {
"type": "object",
"description": "Параметры для настройки процесса оплаты и платежного интерфейса для пользователя.",
"additionalProperties": false,
"properties": {
"ui": {
"$ref": "#/components/schemas/Cart-Payment_settings_ui"
},
"payment_method": {
"$ref": "#/components/schemas/Cart-Payment_settings_payment_method"
},
"return_url": {
"$ref": "#/components/schemas/Cart-Payment_settings_return_url"
},
"redirect_policy": {
"$ref": "#/components/schemas/Cart-Payment_redirect_policy"
}
}
},
"custom_parameters": {
"type": "object",
"description": "Дополнительные пользовательские параметры проекта.",
"minProperties": 1,
"maxProperties": 200
}
}
},
"example": {
"sandbox": true,
"settings": {
"ui": {
"theme": "63295a9a2e47fab76f7708e1",
"desktop": {
"header": {
"is_visible": true,
"visible_logo": true,
"visible_name": true,
"visible_purchase": true,
"type": "normal",
"close_button": false
}
}
}
},
"custom_parameters": {
"character_id": "ingameUsername"
}
}
}
}
},
"Cart-Payment_create-order-with-specified-item-idJsonModel": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"description": "Валюта, в которой указана стоимость заказа. Трехбуквенный код валюты в соответствии с [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Подробную информацию о [валютах, поддерживаемых Xsolla, смотрите в документации](https://developers.xsolla.com/ru/doc/pay-station/references/supported-currencies/)."
},
"locale": {
"type": "string",
"description": "Язык ответа."
},
"sandbox": {
"type": "boolean",
"description": "Создает заказ в тестовом окружении. Эта возможность доступна для пользователей, указанных в списке пользователей компании.",
"default": false
},
"quantity": {
"type": "integer",
"minimum": 1,
"description": "Количество товаров.",
"default": 1
},
"promo_code": {
"type": "string",
"description": "Погашает промокод при оплате."
},
"settings": {
"type": "object",
"description": "Параметры для настройки процесса оплаты и платежного интерфейса для пользователя.",
"additionalProperties": false,
"properties": {
"ui": {
"$ref": "#/components/schemas/Cart-Payment_settings_ui"
},
"payment_method": {
"$ref": "#/components/schemas/Cart-Payment_settings_payment_method"
},
"return_url": {
"$ref": "#/components/schemas/Cart-Payment_settings_return_url"
},
"redirect_policy": {
"$ref": "#/components/schemas/Cart-Payment_redirect_policy"
}
}
},
"custom_parameters": {
"type": "object",
"description": "Дополнительные пользовательские параметры проекта.",
"minProperties": 1,
"maxProperties": 200
}
}
},
"example": {
"sandbox": true,
"quantity": 5,
"promo_code": "discount_code",
"settings": {
"ui": {
"theme": "63295a9a2e47fab76f7708e1",
"desktop": {
"header": {
"is_visible": true,
"visible_logo": true,
"visible_name": true,
"visible_purchase": true,
"type": "normal",
"close_button": false
}
}
}
},
"custom_parameters": {
"character_id": "ingameUsername"
}
}
}
}
},
"admin-order-search": {
"description": "Параметры поиска заказа",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Ограничение на количество заказов для вывода в ответе.",
"minimum": 1,
"maximum": 10,
"default": 10,
"nullable": false
},
"offset": {
"type": "integer",
"description": "Номер заказа, с которого формируется список в ответе (нумерация ведется с 0).",
"default": 0,
"minimum": 0,
"nullable": false
},
"created_date_from": {
"type": "string",
"format": "date-time",
"nullable": false,
"example": "2020-04-15T18:16:00+05:00",
"description": "Дата или дата и время начала периода создания заказов согласно стандарту [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)."
},
"created_date_until": {
"type": "string",
"format": "date-time",
"nullable": false,
"example": "2020-04-16T18:16:00+05:00",
"description": "Дата или дата и время окончания периода создания заказов согласно стандарту [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)."
}
}
},
"example": {
"offset": 0,
"limit": 5,
"created_date_from": "2018-01-07T00:00:00+03:00",
"created_date_until": "2018-01-09T16:00:00+03:00"
}
}
}
},
"Cart-Payment_admin-create-payment-token": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user",
"purchase"
],
"properties": {
"sandbox": {
"$ref": "#/components/schemas/Cart-Payment_settings_sandbox"
},
"user": {
"$ref": "#/components/schemas/Cart-Payment_admin-user-request-body"
},
"purchase": {
"$ref": "#/components/schemas/Cart_admin_payment"
},
"promo_code": {
"$ref": "#/components/schemas/Promotions_coupon_code"
},
"settings": {
"type": "object",
"description": "Параметры для настройки процесса оплаты и платежного интерфейса для пользователя.",
"additionalProperties": false,
"properties": {
"ui": {
"$ref": "#/components/schemas/Cart-Payment_settings_ui"
},
"currency": {
"$ref": "#/components/schemas/Cart-Payment_settings_currency"
},
"language": {
"$ref": "#/components/schemas/Cart-Payment_settings_locale"
},
"external_id": {
"$ref": "#/components/schemas/Cart-Payment_settings_external_id"
},
"payment_method": {
"$ref": "#/components/schemas/Cart-Payment_settings_payment_method"
},
"return_url": {
"$ref": "#/components/schemas/Cart-Payment_settings_return_url"
},
"redirect_policy": {
"$ref": "#/components/schemas/Cart-Payment_redirect_policy"
}
}
},
"custom_parameters": {
"$ref": "#/components/schemas/Cart-Payment_custom_parameters_token"
}
},
"additionalProperties": false
},
"examples": {
"common": {
"value": {
"user": {
"id": {
"value": "user-id"
},
"name": {
"value": "user-name"
},
"email": {
"value": "user@xsolla.com"
},
"country": {
"value": "US",
"allow_modify": false
}
},
"purchase": {
"items": [
{
"sku": "com.xsolla.cup01",
"quantity": 2
},
{
"sku": "com.xsolla.t-shirt01",
"quantity": 1
},
{
"sku": "com.xsolla.cup02",
"quantity": 1
},
{
"sku": "com.xsolla.hat01",
"quantity": 1
}
]
},
"settings": {
"language": "de",
"external_id": "AABBCCDD01",
"currency": "USD",
"payment_method": 1380,
"return_url": "https://developers.xsolla.com/ru/",
"ui": {
"theme": "63295aab2e47fab76f7708e3"
}
}
}
},
"in-sandbox": {
"value": {
"sandbox": true,
"user": {
"id": {
"value": "user-id"
}
},
"purchase": {
"items": [
{
"sku": "com.xsolla.cup01",
"quantity": 2
},
{
"sku": "com.xsolla.t-shirt01",
"quantity": 1
},
{
"sku": "com.xsolla.cup02",
"quantity": 1
},
{
"sku": "com.xsolla.hat01",
"quantity": 1
}
]
},
"settings": {
"currency": "USD"
}
}
},
"with-custom-parameters": {
"value": {
"user": {
"id": {
"value": "user-id"
},
"name": {
"value": "user-name"
},
"email": {
"value": "user@xsolla.com"
},
"country": {
"value": "US",
"allow_modify": false
}
},
"purchase": {
"items": [
{
"sku": "com.xsolla.cup01",
"quantity": 2
},
{
"sku": "com.xsolla.t-shirt01",
"quantity": 1
},
{
"sku": "com.xsolla.cup02",
"quantity": 1
},
{
"sku": "com.xsolla.hat01",
"quantity": 1
}
]
},
"settings": {
"language": "de",
"external_id": "AABBCCDD01",
"currency": "USD",
"payment_method": 1380,
"return_url": "https://developers.xsolla.com/ru/",
"ui": {
"theme": "63295aab2e47fab76f7708e3"
}
},
"custom_parameters": {
"user_public_id": "player1",
"user_os": "windows10"
}
}
}
}
}
}
},
"Cart-Payment_admin-fill-cart-json-model": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cart"
},
"examples": {
"basic": {
"value": {
"currency": "USD",
"items": [
{
"sku": "com.xsolla.cup01",
"quantity": 2
},
{
"sku": "com.xsolla.t-shirt01",
"quantity": 1
},
{
"sku": "com.xsolla.cup02",
"quantity": 1
},
{
"sku": "com.xsolla.hat01",
"quantity": 1
}
]
}
}
}
}
}
},
"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
}
}
}
},
"connector-import-items-body": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"connector_external_id",
"file_url"
],
"properties": {
"connector_external_id": {
"type": "string",
"description": "Фиксированное значение, определяющее тип операции для импорта товаров.",
"enum": [
"import_items"
]
},
"file_url": {
"type": "string",
"description": "URL-адрес файла с данными в формате JSON. Файл должен быть размещен на сервисе хранения данных в публичном доступе. Шаблон файла вы можете скачать в Личном кабинете в разделе [Store > Виртуальные предметы > Управление каталогом > Импортировать товары (JSON)](https://publisher.xsolla.com/0/projects/0/storefront/import-export/import-items).",
"example": "https://my-bucket.s3.amazonaws.com/items.json"
},
"mode": {
"type": "string",
"description": "Действия при импорте:\n\nВозможные значения:\n- `create` — Добавить новые товары.\n- `create_and_update` — Добавить новые товары и обновить существующие.\n- `sync` — Добавить новые товары, обновить существующие и отключить отсутствующие.",
"enum": [
"create",
"create_and_update",
"sync"
],
"default": "create_and_update"
}
}
}
}
}
},
"create-update-region": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"countries",
"name"
],
"properties": {
"countries": {
"$ref": "#/components/schemas/Regions_countries"
},
"name": {
"$ref": "#/components/schemas/Regions_name"
}
},
"example": {
"name": {
"en-US": "Asia",
"de-DE": "Asien"
},
"countries": [
"JP",
"CN",
"VN"
]
}
}
}
}
},
"create-update-attribute": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"external_id",
"name"
],
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"$ref": "#/components/schemas/admin-attribute-name"
}
}
},
"example": {
"external_id": "genre",
"name": {
"en": "Genre",
"de": "Genre"
}
}
}
}
},
"create-update-attribute-value": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/request-attribute-value"
},
"example": {
"external_id": "weapon_class_sword_value",
"value": {
"en": "Sword",
"de": "Schwert"
}
}
}
}
}
},
"examples": {
"422-property-sku-is-required": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `sku` is required",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"422-numbers-of-attribute-values-per-item-exceeded": {
"value": {
"statusCode": 422,
"errorCode": 9909,
"errorMessage": "[0401-9909]: The number of attribute values you specified for the item exceeds the required limit. Try to specify fewer attribute values.",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"422-numbers-of-attributes-per-item-exceeded": {
"value": {
"statusCode": 422,
"errorCode": 9908,
"errorMessage": "[0401-9908]: The number of attributes you specified for the item exceeds the required limit. Try to specify fewer attributes.",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"422-value-limit-exceeded": {
"value": {
"statusCode": 422,
"errorCode": 9908,
"errorMessage": "[0401-9908]: You reached the maximum number of values for the attribute.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"422-custom-attributes-size-exceeded": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity",
"transactionId": "da145238620011eb8e24fe6913ff226a",
"errorMessageExtended": [
{
"property": "custom_attributes",
"message": "JSON can’t exceed 500 characters."
}
]
}
},
"200-admin-get-group-list": {
"value": {
"groups": [
{
"id": 1,
"external_id": "weapons",
"name": {
"en": "Weapons"
},
"description": {
"en": "Player weapons"
},
"image_url": "https://example.com/weapons.png",
"order": 1,
"is_enabled": true,
"items_count": 5
},
{
"id": 2,
"external_id": "swords",
"name": {
"en": "Swords"
},
"description": {
"en": "Melee weapons"
},
"image_url": "https://example.com/swords.png",
"order": 2,
"is_enabled": true,
"items_count": 3
},
{
"id": 3,
"external_id": "armor",
"name": {
"en": "Armor"
},
"description": {
"en": "Player armor"
},
"image_url": "https://example.com/armor.png",
"order": 3,
"is_enabled": true,
"items_count": 4
}
]
}
},
"201-admin-create-group": {
"value": {
"external_id": "weapons"
}
},
"422-property-external-id-required": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": [
{
"property": "external_id",
"message": "The property external_id is required"
}
]
}
},
"200-admin-get-group": {
"value": {
"id": 1,
"external_id": "weapons",
"name": {
"en": "Weapons"
},
"description": {
"en": "Player weapons"
},
"image_url": "https://example.com/weapons.png",
"order": 1,
"is_enabled": true,
"items_count": 5
}
},
"200-admin-get-group-list-by-item-type": {
"value": {
"groups": [
{
"id": 1,
"external_id": "weapons",
"name": {
"en": "Weapons"
},
"description": {
"en": "Player weapons"
},
"image_url": "https://example.com/weapons.png",
"order": 1,
"is_enabled": true,
"items_count": 3,
"is_contains_any_items": true
},
{
"id": 2,
"external_id": "swords",
"name": {
"en": "Swords"
},
"description": {
"en": "Melee weapons"
},
"image_url": "https://example.com/swords.png",
"order": 2,
"is_enabled": true,
"items_count": 2,
"is_contains_any_items": true
},
{
"id": 3,
"external_id": "armor",
"name": {
"en": "Armor"
},
"description": {
"en": "Player armor"
},
"image_url": "https://example.com/armor.png",
"order": 3,
"is_enabled": true,
"items_count": 0,
"is_contains_any_items": false
}
]
}
},
"200-admin-get-group-by-item-type": {
"value": {
"id": 1,
"external_id": "weapons",
"name": {
"en": "Weapons"
},
"description": {
"en": "Player weapons"
},
"image_url": "https://example.com/weapons.png",
"order": 1,
"is_enabled": true,
"items_count": 3,
"is_contains_any_items": true
}
},
"404-game-code-not-found": {
"value": {
"statusCode": 404,
"errorCode": 4603,
"errorMessage": "[0401-4603]: Game code not found.",
"transactionId": "transaction id"
}
},
"422-drm-is-not-drm-free": {
"value": {
"statusCode": 422,
"errorCode": 5103,
"errorMessage": "[0401-5103]: Selected drm is not drmfree.",
"transactionId": "transaction id"
}
},
"422-user-already-has-entitlement": {
"value": {
"statusCode": 422,
"errorCode": 5101,
"errorMessage": "[0401-5101]: User already has entitlement.",
"transactionId": "transaction id"
}
},
"Bundles_200-get-bundle-list": {
"value": {
"has_more": true,
"items": [
{
"item_id": 61031,
"sku": "com.xsolla.kg_1",
"name": "kg_10.00_bundle",
"type": "bundle",
"description": "pricePoint_44056_1",
"image_url": null,
"long_description": null,
"attributes": [
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Casual"
},
{
"external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7",
"value": "Strategy"
},
{
"external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8",
"value": "Mobile"
}
]
}
],
"is_free": false,
"order": 999,
"groups": [
{
"external_id": "exclusive",
"name": "Exclusive",
"item_order_in_group": 1
}
],
"price": {
"amount": "9.99",
"currency": "USD",
"amount_without_discount": "9.99"
},
"total_content_price": {
"amount": "10.99",
"currency": "USD",
"amount_without_discount": "10.99"
},
"media_list": [],
"virtual_prices": [],
"can_be_bought": true,
"bundle_type": "standard",
"promotions": [],
"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"
},
"content": [
{
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"description": "Big Rocket - short description.",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"type": "virtual_currency",
"quantity": 100,
"virtual_item_type": "non_consumable",
"attributes": [
{
"external_id": "size",
"name": "Size",
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Large"
}
]
}
],
"is_free": false,
"groups": [],
"price": {
"amount": "10.99",
"currency": "USD",
"amount_without_discount": "10.99"
},
"virtual_prices": [],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
}
}
],
"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
}
],
"loyalty_prices": [
{
"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": 200
}
]
}
]
}
},
"Bundles_200-get-bundle": {
"value": {
"item_id": 610316,
"sku": "com.xsolla.kg_1",
"name": "kg_10.00_bundle",
"type": "bundle",
"description": "pricePoint_44056_1.",
"image_url": null,
"long_description": null,
"attributes": [],
"is_free": false,
"order": 999,
"groups": [],
"price": {
"amount": "9.99",
"currency": "USD",
"amount_without_discount": "9.99"
},
"total_content_price": {
"amount": "10.99",
"currency": "USD",
"amount_without_discount": "10.99"
},
"media_list": [],
"virtual_prices": [],
"promotions": [],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"can_be_bought": true,
"bundle_type": "standard",
"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"
},
"content": [
{
"description": "Big Rocket - short description.",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"type": "virtual_currency",
"quantity": 100,
"attributes": [],
"is_free": false,
"groups": [],
"price": {
"amount": "10.99",
"currency": "USD",
"amount_without_discount": "10.99"
},
"virtual_prices": [],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
}
}
],
"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
}
],
"loyalty_prices": [
{
"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": 200
}
]
}
},
"404-item-by-sku-not-found": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'item_sku' not found",
"transactionId": "transaction id"
}
},
"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"
}
},
"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+$"
}
]
}
},
"422-item-without-user-limit": {
"value": {
"statusCode": 422,
"errorCode": 4508,
"errorMessage": "[0401-4508]: Item does not have configured user limits.",
"transactionId": "transaction id"
}
},
"422-item-out-of-range-available-user-limit": {
"value": {
"statusCode": 422,
"errorCode": 4510,
"errorMessage": "[0401-4510]: Available item limit is out of range.",
"transactionId": "transaction id"
}
},
"422-external-id-required": {
"value": {
"statusCode": 422,
"errorCode": 9901,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `external_id` is required",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"422-external-id-invalid": {
"value": {
"statusCode": 422,
"errorCode": 9901,
"errorMessage": "[0401-1102]: Unprocessable Entity. Does not match the regex pattern ^[a-zA-Z0-9-_]+$",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"422-external-id-duplicate": {
"value": {
"statusCode": 422,
"errorCode": 9907,
"errorMessage": "[0401-9907]: The attribute value already exists.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"422-value-invalid": {
"value": {
"statusCode": 422,
"errorCode": 9901,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `value` is required",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"422-value-properties-required": {
"value": {
"statusCode": 422,
"errorCode": 9901,
"errorMessage": "[0401-1102]: Unprocessable Entity. Array value found, but an object is required",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"404-attribute-not-found": {
"value": {
"statusCode": 404,
"errorCode": 9901,
"errorMessage": "[0401-9901]: Attribute not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"404-attribute-value-not-found": {
"value": {
"statusCode": 404,
"errorCode": 9906,
"errorMessage": "[0401-9906]: Attribute value not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
},
"x-tagGroups": [
{
"name": "ВИРТУАЛЬНЫЕ ПРЕДМЕТЫ И ВАЛЮТА",
"tags": [
"virtual-items-currency-overview",
"virtual-items-currency-admin",
"virtual-items-currency-catalog",
"virtual-payment"
]
},
{
"name": "ИГРОВЫЕ КЛЮЧИ",
"tags": [
"game-keys-overview",
"game-keys-catalog",
"game-keys-entitlement",
"game-keys-admin"
]
},
{
"name": "БАНДЛЫ",
"tags": [
"bundles-overview",
"bundles-admin",
"bundles-catalog"
]
},
{
"name": "КОРЗИНА И ОПЛАТА",
"tags": [
"cart-and-payment-overview",
"order-life-cycle",
"cart-client-side",
"cart-server-side",
"payment-client-side",
"payment-server-side",
"order",
"free-item"
]
},
{
"name": "ЛИМИТЫ",
"tags": [
"limits-overview",
"user-limits-admin"
]
},
{
"name": "ИМПОРТ ТОВАРОВ",
"tags": [
"connector-admin"
]
},
{
"name": "ОБЩИЕ",
"tags": [
"common-pre-orders",
"common-merchant",
"common-catalog",
"common-regions",
"common-webhooks"
]
},
{
"name": "АТРИБУТЫ ТОВАРА",
"tags": [
"attribute-admin"
]
},
{
"name": "ГРУППЫ ТОВАРОВ",
"tags": [
"item-groups-admin",
"item-groups-catalog"
]
}
]
}