Перейти к содержимому
/
Получение бандла

Catalog API (2.0.0)

Введение

  • Version: 2.0.0
  • Servers: https://store.xsolla.com/api
  • Contact Us by Email
  • Contact URL: https://xsolla.com/
  • Required TLS version: 1.2

API каталога позволяет настраивать каталог внутриигровых товаров на стороне Xsolla и отображать каталог пользователям в вашем игровом магазине.

API позволяет вам управлять такими сущностями каталога, как:

  • Виртуальные предметы — внутриигровые предметы, например оружие, скины, бустеры.
  • Виртуальная валюта — виртуальные деньги, которые используются для приобретения виртуальных товаров. Пакеты виртуальной валюты — предустановленные наборы виртуальной валюты.
  • Бандлы — комбинированные наборы виртуальных предметов, валюты или игровых ключей, продаваемые как единый артикул.
  • Игровые ключи — ключи для игр и DLC, распространяемые через такие платформы, как Steam, или других DRM-провайдеров.
  • Группы — логические группировки для организации и сортировки товаров в каталоге.

Методы API

Методы API делятся на следующие группы:

  • Admin — методы для создания, обновления, удаления и настройки товаров и групп каталога. Для вызова требуется базовая HTTP-аутентификация с использованием учетных данных Личного кабинета. Не предназначены для построения витрин для конечных пользователей.
  • Catalog — методы для получения товаров и построения витрин для конечных пользователей. Поддерживают опциональную аутентификацию с использованием JWT пользователя для возврата персонализированных данных, таких как пользовательские лимиты и активные промоакции.

Аутентификация

Методы API требуют аутентификации либо от имени пользователя, либо от имени проекта. Тип используемой схемы аутентификации указан в блоке Безопасность в описании каждого метода.

Аутентификация с помощью JWT пользователя

Аутентификация с помощью JWT пользователя применяется, когда запрос выполняется из браузера, мобильного приложения или игры. По умолчанию используется XsollaLoginUserJWT. Подробная информация о создании токена приведена в документации Xsolla Login API.

The token is passed in the Authorization header in the following format: Authorization: Bearer <user_JWT>, where <user_JWT> is the user token. The token identifies the user and provides access to personalized data.

В качестве альтернативы вы можете использовать токен для открытия платежного интерфейса.

Базовая HTTP-аутентификация

Базовая HTTP-аутентификация применяется при взаимодействии server-to-server, когда вызов API отправляется напрямую с вашего сервера, а не из браузера пользователя или мобильного приложения. Обычно применяется базовая HTTP-аутентификация с использованием ключа API.

Примечание

Ключ API является конфиденциальным и не должен храниться или использоваться в клиентских приложениях.

При базовой серверной аутентификации все запросы к API должны содержать заголовок:

  • для basicAuth — Authorization: Basic <your_authorization_basic_key>, где your_authorization_basic_key — это пара project_id:api_key, закодированная по стандарту Base64;
  • для basicMerchantAuth — Authorization: Basic <your_authorization_basic_key>, где your_authorization_basic_key — это пара merchant_id:api_key, закодированная по стандарту Base64.

Значения параметров вы можете найти в Личном кабинете:

  • merchant_id отображается:
    • В разделе Настройки компании > Компания.
    • В адресной строке браузера на любой странице Личного кабинета. URL-адрес имеет вид: https://publisher.xsolla.com/<merchant_id>.
  • project_id отображается:
    • В Личном кабинете рядом с названием проекта.
    • В адресной строке браузера при работе с проектом в Личном кабинете. URL-адрес имеет вид: https://publisher.xsolla.com/<merchant_id>/projects/<project_id>.
  • api_key отображается в Личном кабинете только при создании и должен храниться на вашей стороне. Создать ключ можно в разделах:
Внимание

Если необходимый метод API не включает в себя path-параметр project_id, используйте для авторизации ключ API, который действует во всех проектах.

Подробная информация о работе с ключами API приведена в справочнике API.

Аутентификация с поддержкой гостевого доступа

Для продажи корзины используется схема аутентификации AuthForCart, которая поддерживает два режима:

  1. Аутентификация с помощью JWT пользователя. Токен передается в заголовке Authorization в следующем формате: Authorization: Bearer <user_JWT>, где <user_JWT> — токен пользователя. Токен идентифицирует пользователя и обеспечивает доступ к персонализированным данным. В качестве альтернативы вы можете использовать токен для открытия платежного интерфейса.

  2. Упрощенный режим без заголовка. Он применяется только для неавторизованных пользователей и может быть использована только для продажи игровых ключей. Вместо токена в запрос передаются заголовки:

    • x-unauthorized-id с ID запроса;
    • x-user с email пользователя, закодированным в формате Base64.

Базовая структура товара

Товары всех типов (виртуальные предметы, бандлы, виртуальная валюта, ключи) используют схожую структуру данных. Понимание базовой структуры упрощает работу с API и позволяет быстрее ориентироваться в документации.

Примечание

В некоторых методах могут использоваться дополнительные поля, но они не изменяют базовую структуру.

Идентификация

  • merchant_id — ID компании в Личном кабинете;
  • project_id — ID проекта в Личном кабинете;
  • sku — артикул товара, уникальный в рамках проекта.

Отображение в каталоге

  • name — название;
  • description — описание;
  • image_url — ссылка на изображение;
  • is_enabled — доступность товара;
  • is_show_in_store — отображение в каталоге.

Подробнее об управлении доступностью товаров в каталоге – в документации.

Организация

  • type — тип товара, например, виртуальный предмет (virtual_item) или бандл (bundle);
  • groups — группы, к которым относится товар;
  • order — порядок отображения в каталоге.

Условия продажи

  • prices — цены в реальной или виртуальной валюте;
  • limits — ограничения на покупку;
  • periods — период доступности;
  • regions — региональные ограничения.

Пример базовой структуры:

{
  "attributes": [],
  "bundle_type": "virtual_currency_package",
  "content": [
    {
      "description": {
        "en": "Main in-game currency"
      },
      "image_url": "https://.../image.png",
      "name": {
        "en": "Crystals",
        "de": "Kristalle"
      },
      "quantity": 500,
      "sku": "com.xsolla.crystal_2",
      "type": "virtual_currency"
    }
  ],
  "description": {
    "en": "Crystals x500"
  },
  "groups": [],
  "image_url": "https://.../image.png",
  "is_enabled": true,
  "is_free": false,
  "is_show_in_store": true,
  "limits": {
    "per_item": null,
    "per_user": null,
    "recurrent_schedule": null
  },
  "long_description": null,
  "media_list": [],
  "name": {
    "en": "Medium crystal pack"
  },
  "order": 1,
  "periods": [
    {
      "date_from": null,
      "date_until": "2020-08-11T20:00:00+03:00"
    }
  ],
  "prices": [
    {
      "amount": 20,
      "country_iso": "US",
      "currency": "USD",
      "is_default": true,
      "is_enabled": true
    }
  ],
  "regions": [],
  "sku": "com.xsolla.crystal_pack_2",
  "type": "bundle",
  "vc_prices": []
}

Настройка продажи товаров

Xsolla API позволяет реализовать логику магазина внутриигровых товаров,  включая получение каталога, управление корзиной, создание заказов и отслеживание их статусов. В зависимости от сценария интеграции методы API делятся на подразделы Admin и Catalog, которые используют разные схемы аутентификации.

Ниже приведен пример базового сценария настройки и работы магазина — от создания товаров до их продажи пользователю.

Создание товаров и групп (Admin)

Создайте каталог товаров для вашего магазина, например, виртуальные предметы, бандлы или виртуальную валюту.

Примеры методов:

Настройка акций, цепочек, ограничений (Admin)

Настройте инструменты привлечения пользователей и монетизации, например скидки, бонусы, ежедневные награды или цепочки предложений.

Примеры методов:

Получение информации о товарах (Client)

Настройте отображение товаров магазина в вашем приложении.

Внимание

Не используйте методы подраздела Admin для построения каталога пользователям — у таких методов заданы ограничения по частоте запросов, которые не рассчитаны на пользовательский трафик.

Примеры методов:

Примечание

По умолчанию в методах получения каталога возвращаются товары, которые отображаются в магазине на момент запроса. Чтобы получить информацию о товарах, период отображения которых еще не наступил или уже истек, передайте параметр "show_inactive_time_limited_items": 1 при запросе каталога.

Продажа товаров

Вы можете продавать товары за реальную валюту следующими способами:

  • Быстрая покупка — продажа одного товара, но в любом количестве.
  • Покупка корзины — пользователь наполняет корзину, добавляет и удаляет товары, изменяет количество в одном заказе.

Если товар оплачивается внутриигровой валютой, а не реальными деньгами, используйте метод Создание заказа с указанным товаром, приобретенным за виртуальную валюту. Платежный интерфейс открывать не нужно — списание происходит в момент вызова метода.

Если товар бесплатный, используйте метод Создание заказа с указанным бесплатным товаром или метод Создание заказа с помощью бесплатной корзины. Платежный интерфейс открывать не нужно — заказ сразу переходит в статус done.

Быстрая покупка

Используйте клиентский метод создания заказа с указанным товаром – в ответе вы получите токен, который используется для открытия платежного интерфейса.

Примечание

Информация о скидке доступна пользователю только в платежном интерфейсе. Использование промокодов не предусмотрено.

Покупка корзины

Наполнение и покупка корзины может осуществляться на клиенте или на сервере.

Наполнение и покупка корзины на клиенте

Самостоятельно реализуйте логику добавления и удаления товаров. Также необходимо учитывать, что до вызова метода наполнения корзины у вас не будет информации о том, какие акции будут применены при покупке. Это означает, что итоговая стоимость и сведения о добавленных бонусных предметах будут неизвестны.

Реализуйте следующую логику работы с корзиной:

  1. После наполнения корзины игроком используйте метод Наполнение корзины товарами для наполнения корзины. В ответе вернется текущая информация о выбранных товарах — цены до и после применения скидок, бонусные товары.
  2. Обновите содержимое корзины в соответствии с действиями пользователя:
Примечание

Если вы хотите получить актуальное состояние корзины, используйте метод Получение корзины текущего пользователя.
  1. Используйте метод покупки корзины Создание заказа со всеми товарами из текущей корзины. В ответе вернутся ID заказа и платежный токен. Заказу будет присвоен статус new.

Наполнение и покупка корзины на сервере

Этот вариант наполнения корзины может занимать значительное время на настройку, поскольку каждое изменение корзины может сопровождаться вызовом большего количества методов API.

Реализуйте следующую логику работы с корзиной:

  1. После наполнения корзины игроком используйте методс Наполнение корзины товарамидля наполнения корзины. В ответе вернется текущая информация о выбранных товарах — цены до и после применения скидок, бонусные товары.
  2. Используйте метод покупки корзины Создание заказа со всеми товарами из текущей корзины. В ответе вернутся ID заказа и платежный токен. Заказу будет присвоен статус new.

Открытие платежного интерфейса

Используйте полученный токен для открытия платежного интерфейса в новом окне. Другие способы открытия платежного интерфейса описаны в документации.

ДействиеЭндпоинт
Открыть в боевом окружении.https://secure.xsolla.com/paystation4/?token={token}
Открыть в тестовом окружении.https://sandbox-secure.xsolla.com/paystation4/?token={token}
Примечание

Используйте тестовый режим (sandbox-режим) при разработке и тестировании — при совершении тестовой покупки с реальных счетов не списываются деньги. Для тестирования вы можете использовать тестовые банковские карты.

После проведения первого реального платежа в силу вступает строгая политика платежей в тестовом окружении. Проведение платежа в нем будет доступно только для пользователей, которые указаны в Личном кабинете в разделе Настройки компании > Пользователи.

Покупка виртуальной валюты и виртуальных предметов за реальную валюту возможна после подписания лицензионного договора с Xsolla. Для этого в Личном кабинете перейдите в Договоры и налоги > Договоры, заполните договор и дождитесь подтверждения согласования. Согласование может занять до 3 рабочих дней.

Для включения или отключения тестового режима вам необходимо изменить значение параметра sandbox в теле запроса методов быстрой покупки и покупки корзины. По умолчанию тестовый режим выключен.

Возможные статусы заказа: - new — заказ создан; - paid — оплата получена; - done — товар начислен; - canceled — заказ отменен; - expired — истек срок оплаты.

Отслеживайте статус одним из следующих способов:

Пагинация

Методы API для запроса большого количества записей (например, для построения каталога) возвращают данные постранично. Пагинация — это механизм ограничения количества элементов, возвращаемых в одном ответе API, с возможностью последовательного получения следующих страниц.

Для управления количеством возвращаемых элементов используйте следующие параметры:

  • limit — количество элементов на странице;
  • offset — номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0);
  • has_more — есть ли следующая страница;
  • total_items_count — общее количество элементов.

Пример запроса:

GET /items?limit=20&offset=40

Пример ответа:

{
  "items": [...],
  "has_more": true,
  "total_items_count": 135
}

Рекомендуется выполнять последовательные запросы до тех пор, пока в ответе не вернется has_more = false.

Формат даты и времени

Дата и время передаются в формате ISO 8601.

Поддерживаются:

  • смещение относительно UTC;
  • значение null, когда нет ограничения времени отображения предмета;
  • в отдельных полях используется Unix timestamp (в секундах).

Формат: YYYY-MM-DDTHH:MM:SS±HH:MM

Пример: 2026-03-16T10:00:00+03:00

Локализация

Xsolla поддерживает локализацию пользовательских полей, таких как название и описание товаров. Локализованные значения передаются в виде объекта, в котором ключом является код языка. Полный список поддерживаемых языков приведен в документации.

Поддерживаемые поля

Локализация может быть задана для следующих параметров:

  • name
  • description
  • long_description

Формат локали

Ключ локали может быть указан в одном из следующих форматов:

  • двухбуквенный код языка: en, ru
  • формат язык–страна: en-US, ru-RU, de-DE

Примеры

Пример с двухбуквенным кодом языка:

{
  "name": {
    "en": "Starter Pack",
    "ru": "Стартовый набор"
  }
}

Пример с форматом язык–страна:

{
  "description": {
    "en-US": "Premium bundle",
    "de-DE": "Premium-Paket"
  }
}

Формат ответа при ошибке

При возникновении ошибки API возвращает HTTP-статус и тело ответа в формате JSON. Полный список ошибок в работе магазина приведен в документации.

Пример ответа:

{
  "errorCode": 1102,
  "errorMessage": "Validation error",
  "statusCode": 422,
  "transactionId": "c9e1a..."
}
  • errorCode — код ошибки.
  • errorMessage — краткое описание ошибки.
  • statusCode — HTTP статус ответа.
  • transactionId — ID запроса. Возвращается не во всех случаях.
  • errorMessageExtended — дополнительные данные об ошибке, например параметры запроса. Возвращаются не во всех случаях.

Пример расширенного ответа:

{
  "errorCode": 7001,
  "errorMessage": "Chain not found",
  "errorMessageExtended": {
    "chain_id": "test_chain_id",
    "project_id": "test_project_id",
    "step_number": 2
  },
  "statusCode": 404
}

Частые HTTP-статусы

  • 400 — некорректный запрос
  • 401 — ошибка аутентификации
  • 403 — недостаточно прав доступа
  • 404 — ресурс не найден
  • 422 — ошибка валидации данных
  • 429 — превышено ограничение частоты запросов

Рекомендации

  • Обрабатывайте HTTP-статус и тело ответа совместно.
  • Используйте errorCode для обработки ошибок, связанных с логикой работы приложения.
  • Используйте transactionId, чтобы быстрее идентифицировать запросы при анализе ошибок.
Скачать описание OpenAPI
index.json
index.yaml
Языки
Серверы
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/ru/api/catalog/

Основная информация

С помощью виртуальных предметов и валюты вы можете построить внутриигровой магазин и настроить его отображение пользователям. Доступны следующие типы товаров:

  • Виртуальные предметы — внутриигровые товары, например оружие, скины или бустеры. Продаются за реальные деньги или виртуальную валюту.
  • Виртуальная валюта — внутриигровая валюта для покупки виртуальных предметов. Продается за реальные деньги или виртуальную валюту.
  • Пакеты виртуальной валюты — фиксированное количество виртуальной валюты. Продается за реальные деньги или виртуальную валюту.

Для организации товаров в каталоге используются группы. Они позволяют логически объединять товары и управлять их отображением.

Используйте методы подраздела Admin для создания, обновления и удаления товаров.

Используйте методы подраздела Catalog для получения списков товаров и их отображения пользователям.

Уведомление

Не используйте методы подраздела Admin для построения каталога пользователям.

Примечание

Метод Получение списка виртуальных предметов возвращает подробные данные о предметах, включая цены и атрибуты, и поддерживает пагинацию — используйте его для отображения страниц каталога в витрине магазина.

Метод Получение списка всех виртуальных предметов возвращает артикул, название и описание предмета, а также ID и название группы без пагинации — используйте его для поиска или индексирования на стороне клиента.

Для реализации покупок за виртуальную валюту используйте метод Создание заказа с указанным товаром, приобретенным за виртуальную валюту. Открывать платежный интерфейс не нужно — списание происходит в момент вызова метода.

Пример сценария покупки товара за виртуальную валюту:

Purchase flow with virtual currency example

Admin

Операции

Catalog

Операции

Виртуальная оплата

Операции

Основная информация

Game keys are single-use unique alphanumeric codes that grant users access to a game or DLC on gaming platforms. You can sell game keys via a direct link, through the store UI, or via a widget. You can also configure regional restrictions to sell game keys in specific countries. For detailed information, refer to the Game keys packages section.

User authentication is not required to sell game keys — the keys are sent to the email the user specified at checkout. You can configure authentication to enable additional scenarios: personalization, purchase limits, or an entitlement system. For detailed information, refer to the How to set up authentication when selling game keys section.

Game key sales flow:

  1. Create a game using the Create game API call.
  2. Configure regional restrictions.
  3. Upload keys to a game key package using the Upload codes API call to make them available for purchase.
  4. Display the game catalog with prices for the user's region using the Get games list API call.
  5. Create an order. For a fast purchase, you can use the Create order with all items from current cart API call, passing the game key SKU. The response returns a token for opening the payment UI.
  6. Implement the opening of the payment UI to pay for the order.

To receive timely notifications about successful payments and deliver items to the user, set up order status tracking, for example, using webhooks. The keys are sent to the email the user specified at checkout, and the order moves to the done status.

Game keys

Catalog

Операции

Владение играми

Операции

Admin

Операции

Основная информация

Bundles are sets of items sold as a single unit. A bundle can include virtual items, virtual currency, virtual currency packages, game keys, and other bundles. Use bundles to create starter packs, seasonal offers, and special deals.

Use the following API call groups to work with bundles:

  • Use API calls from the Admin subsection to create, update, delete bundles, and manage their visibility.
  • Use API calls from the Catalog subsection to retrieve bundles.

Purchase limits are configured via the limits object when creating or updating a bundle. For more information, refer to the Limits overview. You can also configure regional restrictions to sell items in specific countries.

Note

For detailed information on configuring bundles, refer to the Bundles section.

Bundle management scenario:

  1. Create a bundle using the Create bundle API call. To verify the created bundle, use the Get bundle API call. To retrieve all bundles in the project, use the Get list of bundles API call.
  2. If needed, use the Update bundle API call to modify the bundle content or settings.
  3. Implement bundle display logic in your storefront using the Get list of bundles, Get specified bundle, or Get list of bundles by specified group API call.
  4. Create an order using the Cart and payment section. For example, for a fast purchase you can use the Create order with specified item API call, passing the bundle SKU. The response contains a token for opening the payment UI.
  5. Implement opening the payment UI to pay for the order.
  6. Set up order status tracking, for example using webhooks, to promptly receive data on successfully paid items and grant them to the user.

Bundle management scenario

Admin

Операции

Удаление бандлаServer-sideAdmin

Запрос

Удаляет бандл.

Безопасность
basicAuth
Путь
project_idintegerобязательный

ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта, а также в адресной строке браузера при работе с проектом. URL-адрес имеет следующий формат: https://publisher.xsolla.com/<merchant_id>/projects/<project_id>.

Пример: 44056
skustringобязательный

Артикул бандла.

Пример: kg_1
curl -i -X DELETE \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/items/bundle/sku/kg_1

Ответы

Бандл успешно удален.

Тело
Ответ
Нет содержимого

Получение бандлаServer-sideAdmin

Запрос

Получает бандл в рамках проекта для администрирования.

Примечание

Не используйте данный метод для построения каталога магазина.
Безопасность
basicAuth
Путь
project_idintegerобязательный

ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта, а также в адресной строке браузера при работе с проектом. URL-адрес имеет следующий формат: https://publisher.xsolla.com/<merchant_id>/projects/<project_id>.

Пример: 44056
skustringобязательный

Артикул бандла.

Пример: kg_1
curl -i -X GET \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/items/bundle/sku/kg_1

Ответы

Указанный бандл успешно получен.

Телоapplication/json
item_idinteger[ 1 .. 255 ] characters

Внутренний уникальный ID виртуального предмета или валюты.

skustring[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$

Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания.

name(object or null)

Объект с локализованными названиями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код языка из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется двухбуквенный код языка. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.

Any of:

Двухбуквенные строчные языковые коды.

name.​enstring or null

Английский

name.​arstring or null

Арабский

name.​bgstring or null

Болгарский

name.​cnstring or null

Китайский упрощенный

name.​csstring or null

Чешский

name.​destring or null

Немецкий

name.​esstring or null

Испанский

name.​frstring or null

Французский

name.​hestring or null

Иврит

name.​itstring or null

Итальянский

name.​jastring or null

Японский

name.​kostring or null

Корейский

name.​plstring or null

Польский

name.​ptstring or null

Португальский

name.​rostring or null

Румынский

name.​rustring or null

Русский

name.​thstring or null

Тайский

name.​trstring or null

Турецкий

name.​twstring or null

Китайский традиционный

name.​vistring or null

Вьетнамский

name.​kmstring or null

Кхмерский

name.​idstring or null

Индонезийский

name.​lostring or null

Лаосский

name.​mystring or null

Бирманский

name.​phstring or null

Филиппинский

name.​nestring or null

Непальский

attributesArray of objects

Список атрибутов.

Пример: [{"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"}}]}]
attributes[].​external_idstring[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$обязательный

Уникальный ID атрибута. external_id может содержать только строчные и заглавные латинские буквы, цифры, тире и подчеркивания.

Пример: "attribute_external_id"
attributes[].​nameobject

Объект с локализациями для названия атрибута. Ключи для обозначения стран указаны в стандарте ISO 3166-1.

Пример: {"en":"Attribute name","de":"Attributname"}
attributes[].​name.​property name*stringдополнительное свойство
attributes[].​valuesArray of objectsобязательный
Пример: [{"external_id":"value_1","name":{"en":"value 1","de":"wert 1"}},{"external_id":"value_2","name":{"en":"value 2","de":"wert 2"}}]
attributes[].​values[].​external_idstring[ 1 .. 255 ] characters^[-_.\d\w]+$обязательный

Уникальный ID значения атрибута. external_id может содержать только строчные латинские буквы, цифры, тире и подчеркивания.

Пример: "value_external_id"
attributes[].​values[].​valueobjectобязательный

Объект с локализациями для названия значения. Ключи для обозначения стран указаны в стандарте ISO 3166-1.

attributes[].​values[].​value.​property name*stringдополнительное свойство
typestring

Тип товара.

bundle_typestring

Тип бандла. Возвращается, если тип элемента является бандлом.

Перечисление"standard""virtual_currency_package""partner_side_content"
description(object or null)

Объект с локализованными описаниями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код локали из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется код из двух символов. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.

Any of:

Двухбуквенные строчные языковые коды.

description.​enstring or null

Английский

description.​arstring or null

Арабский

description.​bgstring or null

Болгарский

description.​cnstring or null

Китайский упрощенный

description.​csstring or null

Чешский

description.​destring or null

Немецкий

description.​esstring or null

Испанский

description.​frstring or null

Французский

description.​hestring or null

Иврит

description.​itstring or null

Итальянский

description.​jastring or null

Японский

description.​kostring or null

Корейский

description.​plstring or null

Польский

description.​ptstring or null

Португальский

description.​rostring or null

Румынский

description.​rustring or null

Русский

description.​thstring or null

Тайский

description.​trstring or null

Турецкий

description.​twstring or null

Китайский традиционный

description.​vistring or null

Вьетнамский

description.​kmstring or null

Кхмерский

description.​idstring or null

Индонезийский

description.​lostring or null

Лаосский

description.​mystring or null

Бирманский

description.​phstring or null

Филиппинский

description.​nestring or null

Непальский

long_description(object or null)

Объект с локализованными длинными описаниями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код локали из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется код из двух символов. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.

Any of:

Двухбуквенные строчные языковые коды.

long_description.​enstring or null

Английский

long_description.​arstring or null

Арабский

long_description.​bgstring or null

Болгарский

long_description.​cnstring or null

Китайский упрощенный

long_description.​csstring or null

Чешский

long_description.​destring or null

Немецкий

long_description.​esstring or null

Испанский

long_description.​frstring or null

Французский

long_description.​hestring or null

Иврит

long_description.​itstring or null

Итальянский

long_description.​jastring or null

Японский

long_description.​kostring or null

Корейский

long_description.​plstring or null

Польский

long_description.​ptstring or null

Португальский

long_description.​rostring or null

Румынский

long_description.​rustring or null

Русский

long_description.​thstring or null

Тайский

long_description.​trstring or null

Турецкий

long_description.​twstring or null

Китайский традиционный

long_description.​vistring or null

Вьетнамский

long_description.​kmstring or null

Кхмерский

long_description.​idstring or null

Индонезийский

long_description.​lostring or null

Лаосский

long_description.​mystring or null

Бирманский

long_description.​phstring or null

Филиппинский

long_description.​nestring or null

Непальский

image_urlstring or null

URL-адрес изображения. Для корректного отображения и быстрой загрузки изображения в платежном интерфейсе проверьте требования к файлу и ссылке:

  • Поддерживаемые форматы: WebP (рекомендуется), PNG, JPG.
  • Размер файла: ≤ 50 КБ (для WebP) или ≤ 150 КБ (для PNG и JPG).
  • Размер изображения: 280 x 280 px.
  • Цветовое пространство: sRGB.
  • Протокол передачи данных: HTTPS с долгосрочным кэшированием версионированных URL-адресов.

is_freeboolean

Является ли товар бесплатным.

is_paid_randomized_rewardboolean

Является ли товар случайной платной наградой, например лутбоксом.

groupsArray of objects

Группы, к которым принадлежит товар.

groups[].​external_idstring
Пример: "horror"
groups[].​nameobject

Название элемента. Должно содержать пары ключ/значение, где ключ — это языковой стандарт в {2}формате "^[a-z]", значение — строка.

По умолчанию {"en":"Horror"}
Пример: {"en":"Horror","de":"Horror"}
groups[].​name.​property name*stringдополнительное свойство
pricesArray of objects

Цены в реальных валютах.

prices[].​amountstring^\d*\.?\d*$обязательный

Цена товара.

prices[].​currencystringобязательный

Валюта, в которой указана цена товара. Трехбуквенный код в соответствии со стандартом ISO 4217.

prices[].​is_defaultbooleanобязательный

Цена по умолчанию используется для построения каталога, если цена в валюте пользователя не указана.

prices[].​is_enabledbooleanобязательный

Цена включена.

prices[].​country_isostring or null

Страна, где доступна эта цена. Двухбуквенный код в соответствии с ISO 3166-1 alpha 2.

Пример: "US"
virtual_pricesArray of objects
virtual_prices[].​skustring[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$

Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания.

virtual_prices[].​name(object or null)

Объект с локализованными названиями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код языка из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется двухбуквенный код языка. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.

Any of:

Двухбуквенные строчные языковые коды.

virtual_prices[].​name.​enstring or null

Английский

virtual_prices[].​name.​arstring or null

Арабский

virtual_prices[].​name.​bgstring or null

Болгарский

virtual_prices[].​name.​cnstring or null

Китайский упрощенный

virtual_prices[].​name.​csstring or null

Чешский

virtual_prices[].​name.​destring or null

Немецкий

virtual_prices[].​name.​esstring or null

Испанский

virtual_prices[].​name.​frstring or null

Французский

virtual_prices[].​name.​hestring or null

Иврит

virtual_prices[].​name.​itstring or null

Итальянский

virtual_prices[].​name.​jastring or null

Японский

virtual_prices[].​name.​kostring or null

Корейский

virtual_prices[].​name.​plstring or null

Польский

virtual_prices[].​name.​ptstring or null

Португальский

virtual_prices[].​name.​rostring or null

Румынский

virtual_prices[].​name.​rustring or null

Русский

virtual_prices[].​name.​thstring or null

Тайский

virtual_prices[].​name.​trstring or null

Турецкий

virtual_prices[].​name.​twstring or null

Китайский традиционный

virtual_prices[].​name.​vistring or null

Вьетнамский

virtual_prices[].​name.​kmstring or null

Кхмерский

virtual_prices[].​name.​idstring or null

Индонезийский

virtual_prices[].​name.​lostring or null

Лаосский

virtual_prices[].​name.​mystring or null

Бирманский

virtual_prices[].​name.​phstring or null

Филиппинский

virtual_prices[].​name.​nestring or null

Непальский

virtual_prices[].​typestring

Тип виртуальной валюты.

virtual_prices[].​description(object or null)

Объект с локализованными описаниями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код локали из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется код из двух символов. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.

Any of:

Двухбуквенные строчные языковые коды.

virtual_prices[].​description.​enstring or null

Английский

virtual_prices[].​description.​arstring or null

Арабский

virtual_prices[].​description.​bgstring or null

Болгарский

virtual_prices[].​description.​cnstring or null

Китайский упрощенный

virtual_prices[].​description.​csstring or null

Чешский

virtual_prices[].​description.​destring or null

Немецкий

virtual_prices[].​description.​esstring or null

Испанский

virtual_prices[].​description.​frstring or null

Французский

virtual_prices[].​description.​hestring or null

Иврит

virtual_prices[].​description.​itstring or null

Итальянский

virtual_prices[].​description.​jastring or null

Японский

virtual_prices[].​description.​kostring or null

Корейский

virtual_prices[].​description.​plstring or null

Польский

virtual_prices[].​description.​ptstring or null

Португальский

virtual_prices[].​description.​rostring or null

Румынский

virtual_prices[].​description.​rustring or null

Русский

virtual_prices[].​description.​thstring or null

Тайский

virtual_prices[].​description.​trstring or null

Турецкий

virtual_prices[].​description.​twstring or null

Китайский традиционный

virtual_prices[].​description.​vistring or null

Вьетнамский

virtual_prices[].​description.​kmstring or null

Кхмерский

virtual_prices[].​description.​idstring or null

Индонезийский

virtual_prices[].​description.​lostring or null

Лаосский

virtual_prices[].​description.​mystring or null

Бирманский

virtual_prices[].​description.​phstring or null

Филиппинский

virtual_prices[].​description.​nestring or null

Непальский

virtual_prices[].​image_urlstring or null

URL-адрес изображения. Для корректного отображения и быстрой загрузки изображения в платежном интерфейсе проверьте требования к файлу и ссылке:

  • Поддерживаемые форматы: WebP (рекомендуется), PNG, JPG.
  • Размер файла: ≤ 50 КБ (для WebP) или ≤ 150 КБ (для PNG и JPG).
  • Размер изображения: 280 x 280 px.
  • Цветовое пространство: sRGB.
  • Протокол передачи данных: HTTPS с долгосрочным кэшированием версионированных URL-адресов.

virtual_prices[].​amountstring^\d*\.?\d*$

Цена товара со скидкой.

virtual_prices[].​is_defaultboolean

Является ли данная цена товара ценой по умолчанию.

media_listArray of objects or null
Any of:

Дополнительные ассеты бандла.

media_list[].​typestring

Тип медиа: image/video.

Перечисление"image""video"
Пример: "image"
media_list[].​urlstring

Ссылка на файл.

Пример: "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
orderinteger

Приоритет заказа бандла в списке.

is_enabledboolean

Если этот параметр отключен, товар не может быть найден и приобретен.

is_show_in_storeboolean

Товар доступен для покупки.

regionsArray of objects
regions[].​idinteger>= 1
Пример: 1
contentArray of objects
content[].​skustring[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$

Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания.

content[].​name(object or null)

Объект с локализованными названиями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код языка из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется двухбуквенный код языка. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.

Any of:

Двухбуквенные строчные языковые коды.

content[].​name.​enstring or null

Английский

content[].​name.​arstring or null

Арабский

content[].​name.​bgstring or null

Болгарский

content[].​name.​cnstring or null

Китайский упрощенный

content[].​name.​csstring or null

Чешский

content[].​name.​destring or null

Немецкий

content[].​name.​esstring or null

Испанский

content[].​name.​frstring or null

Французский

content[].​name.​hestring or null

Иврит

content[].​name.​itstring or null

Итальянский

content[].​name.​jastring or null

Японский

content[].​name.​kostring or null

Корейский

content[].​name.​plstring or null

Польский

content[].​name.​ptstring or null

Португальский

content[].​name.​rostring or null

Румынский

content[].​name.​rustring or null

Русский

content[].​name.​thstring or null

Тайский

content[].​name.​trstring or null

Турецкий

content[].​name.​twstring or null

Китайский традиционный

content[].​name.​vistring or null

Вьетнамский

content[].​name.​kmstring or null

Кхмерский

content[].​name.​idstring or null

Индонезийский

content[].​name.​lostring or null

Лаосский

content[].​name.​mystring or null

Бирманский

content[].​name.​phstring or null

Филиппинский

content[].​name.​nestring or null

Непальский

content[].​typestring

Тип товара.

content[].​description(object or null)

Объект с локализованными описаниями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код локали из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется код из двух символов. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.

Any of:

Двухбуквенные строчные языковые коды.

content[].​description.​enstring or null

Английский

content[].​description.​arstring or null

Арабский

content[].​description.​bgstring or null

Болгарский

content[].​description.​cnstring or null

Китайский упрощенный

content[].​description.​csstring or null

Чешский

content[].​description.​destring or null

Немецкий

content[].​description.​esstring or null

Испанский

content[].​description.​frstring or null

Французский

content[].​description.​hestring or null

Иврит

content[].​description.​itstring or null

Итальянский

content[].​description.​jastring or null

Японский

content[].​description.​kostring or null

Корейский

content[].​description.​plstring or null

Польский

content[].​description.​ptstring or null

Португальский

content[].​description.​rostring or null

Румынский

content[].​description.​rustring or null

Русский

content[].​description.​thstring or null

Тайский

content[].​description.​trstring or null

Турецкий

content[].​description.​twstring or null

Китайский традиционный

content[].​description.​vistring or null

Вьетнамский

content[].​description.​kmstring or null

Кхмерский

content[].​description.​idstring or null

Индонезийский

content[].​description.​lostring or null

Лаосский

content[].​description.​mystring or null

Бирманский

content[].​description.​phstring or null

Филиппинский

content[].​description.​nestring or null

Непальский

content[].​image_urlstring or null

URL-адрес изображения. Для корректного отображения и быстрой загрузки изображения в платежном интерфейсе проверьте требования к файлу и ссылке:

  • Поддерживаемые форматы: WebP (рекомендуется), PNG, JPG.
  • Размер файла: ≤ 50 КБ (для WebP) или ≤ 150 КБ (для PNG и JPG).
  • Размер изображения: 280 x 280 px.
  • Цветовое пространство: sRGB.
  • Протокол передачи данных: HTTPS с долгосрочным кэшированием версионированных URL-адресов.

content[].​quantityinteger>= 1

Количество единиц товара данного типа в бандле.

По умолчанию 1
limitsobject or null

Ограничения на продажу товара.

limits.​per_userobject or null

Ограничение количества товара для отдельного пользователя.

limits.​per_user.​totalinteger

Максимальное количество товара, которое может приобрести один пользователь.

limits.​per_user.​limit_exceeded_visibilitystring

Определяет видимость товара в каталоге после достижения лимита покупок до момента следующего обновления лимитов.

Применяется к товарам, для которых задано регулярное обновление лимитов в массиве recurrent_schedule.

Если обновление лимитов не задано, товар не отображается в каталоге после достижения лимита независимо от значения limit_exceeded_visibility.

Возможные значения:

  • show — Товар возвращается в методах получения каталога товаров после достижения лимита покупок. В клиентских методах получения каталога после достижения лимита товар возвращается с флагом can_be_bought: false. Дата следующего сброса возвращается в reset_next_date.
  • hide — Товар не возвращается в методах получения каталога товаров после достижения лимита покупок до момента сброса лимитов.
Перечисление"show""hide"
limits.​per_itemobject or null

Глобальное ограничение товара.

limits.​per_item.​totalinteger

Максимальное количество товара, которое могут приобрести все пользователи.

limits.​per_item.​availableinteger

Оставшееся количество товара, которое могут приобрести все пользователи.

limits.​per_item.​reservedinteger
limits.​per_item.​soldinteger
limits.​recurrent_scheduleobject or null

Период обновления установленный ограничений.

limits.​recurrent_schedule.​per_userobject

Период обновления установленный ограничений для пользователя.

One of:

Ежедневное обновления пользовательских ограничений.

limits.​recurrent_schedule.​per_user.​interval_typestring

Recurrent refresh period type.

Значение"daily"
limits.​recurrent_schedule.​per_user.​timestring(full-time)

Время обновления ограничений в желаемом часовом поясе (округление до часов).

Пример: "11:00:00+03:00"
limits.​recurrent_schedule.​per_user.​reset_next_dateinteger

Date and time when limits refresh (Unix Timestamp).

Пример: 1677553200
limits.​recurrent_schedule.​per_user.​displayable_reset_start_datestring(date-time)

Date and time of the first limit refresh (ISO 8601).

Пример: "2023-02-28T11:00:00+08:00"
limits.​recurrent_schedule.​per_user.​displayable_reset_next_datestring(date-time)

Date and time when limits should reset (ISO 8601).

Пример: "2023-02-28T11:00:00+08:00"
periodsArray of objects

Период продажи товара.

periods[].​date_fromstring or null(date-time)

Дата, когда указанный товар будет доступен для продажи.

Пример: "2020-08-11T10:00:00+03:00"
periods[].​date_untilstring or null(date-time)

Дата, когда указанный товар станет недоступен для продажи. Может быть null.

Пример: "2020-08-11T20:00:00+03:00"
custom_attributesobject(json)

JSON-объект, содержащий атрибуты товара и их значения.

total_content_priceobject or null

Сумма цен содержимого бандла.

total_content_price.​amountstring

Сумма цен содержимого бандла со скидкой.

Пример: "100.99"
total_content_price.​amount_without_discountstring

Сумма цен содержимого бандла.

Пример: "100.99"
total_content_price.​currencystring

Валюта, в которой указана цена товара. Трехбуквенный код в соответствии со стандартом ISO 4217.

Ответ
application/json
{
  "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": [
    { … }
  ],
  "prices": [],
  "virtual_prices": [
    { … }
  ],
  "media_list": [],
  "order": 1,
  "is_enabled": true,
  "is_show_in_store": true,
  "regions": [],
  "bundle_type": "standard",
  "content": [
    { … },
    { … },
    { … }
  ],
  "limits": {
    "per_user": { … },
    "per_item": null,
    "recurrent_schedule": null
  },
  "periods": [
    { … }
  ],
  "custom_attributes": {
    "type": "lootbox",
    "purchased": 0
  }
}

Отображение бандла в каталогеServer-sideAdmin

Запрос

Показывает бандл в каталоге.

Безопасность
basicAuth
Путь
project_idintegerобязательный

ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта, а также в адресной строке браузера при работе с проектом. URL-адрес имеет следующий формат: https://publisher.xsolla.com/<merchant_id>/projects/<project_id>.

Пример: 44056
skustringобязательный

Артикул бандла.

Пример: kg_1
curl -i -X PUT \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/items/bundle/sku/kg_1/show

Ответы

Бандл успешно отображен.

Тело
Ответ
Нет содержимого

Catalog

Операции

Основная информация

The cart is a purchasing mechanism that enables combining multiple items into a single order. A user can buy items of any type in any quantity for real currency, as well as use promo codes.

The cart is stored on the Xsolla side. Saving the cart across sessions depends on whether the user is authorized:

  • For authorized users, the cart is linked to a specific user and is saved across sessions as long as requests are sent on behalf of the same user.

  • For unauthorized users, saving the cart depends on passing the x-unauthorized-id header. To save the cart of an unauthorized user across sessions, pass the same x-unauthorized-id in every request. This option is available only for game key sales.

You can identify the cart in two ways: automatically by user's JWT or by cart ID (cart_id).

Cart management is available both on the client side and on the server side.

On the server side, you can fill the cart with items, e.g., when restoring a user session. The following actions are available on the client side:

  • retrieve the current user's cart or a cart by ID
  • fill the cart
  • update items in the cart
  • delete items from the cart

To purchase items from the cart, the client and server calls for order creation are used.

The cart’s time to live (TTL) is 72 hours by default. If its content changes, e.g., when a new item is added, the TTL is extended.

After successful payment, the cart isn’t cleared automatically. To clear the cart, use the following client-side API calls:

Cart usage scenario:

  1. Implement a store UI where the user will select items.

  2. When the user selects items in the store, add them to the cart, e.g., using the Fill cart with items call. In the items array, you need to pass the SKUs and the required quantity of items.

  3. Implement the cart viewing UI. When the user navigates to the cart, display its contents using the Get current user's cart call. The response will return information about the final price of the items, including discounts and applied promotions.

  4. Implement the opening of the payment UI to pay for the order. For example, you can use the Create order with all items from particular cart call. The response returns a token to open the payment UI.

  5. Configure order status tracking, e.g., using webhooks, to promptly receive data about successfully paid items and grant them to the user.

Note

To implement selling items in-game and online, refer to the integration guide.

Cart and payment flow

Жизненный цикл заказа

Понимание жизненного цикла заказа поможет вам при настройке его отслеживания, например, чтобы начислить товары пользователю после успешной оплаты.

Заказ переходит по следующим статусам:

СтатусОписаниеПримечание
newЗаказ создан. Система ожидает подтверждение оплаты.Описания статусов транзакций приведены в документации Pay Station API.
paidЗаказ оплачен (транзакция перешла в статус done), и товар может быть начислен пользователю. Пока заказ не оплачен, он находится в статусе new.
doneТовар из заказа начислен пользователю. —
canceledПользователь оформил возврат платежа. Заказ переходит в этот статус, когда статус транзакции меняется на refunded.
expired Если новый заказ включает в себя товар, промокод или акцию, на которые настроены ограничения, предыдущий неоплаченный заказ с этим же товаром переходит в статус expired. Пользователь может оплатить только последний созданный заказ. Если пользователь пытается оплатить заказ, который находится в этом статусе, в платежном интерфейсе он увидит ошибку 2002 и не сможет совершить платеж.

Жизненный цикл заказа

Примечание

Если в процессе оплаты заказ перешел в статус expired, но пользователь успешно завершил платеж, заказ переходит из статуса expired в paid. Это возможно только если при оплате такого заказа не будет превышен лимит на покупку товара.

Корзина (на стороне клиента)

Используйте методы из этого подраздела для управления корзиной на стороне клиента.

Операции

Корзина (на стороне сервера)

Используйте методы из этого подраздела для управления корзиной на стороне сервера.

Операции

Оплата (на стороне клиента)

Используйте методы из этого подраздела для формирования платежного токена на стороне клиента.

Операции

Оплата (на стороне сервера)

Используйте методы из этого подраздела для формирования платежного токена на стороне сервера.

Операции

Заказ

Используйте методы из этого раздела для получения информации о заказах.

Операции

Бесплатные товары

Используйте методы из этого подраздела для начисления бесплатных товаров пользователям.

Операции

Основная информация

Лимиты на покупку ограничивают количество товаров, доступных одному пользователю или всем пользователям. Вы также можете задавать периоды автоматического обновления лимитов.

Лимиты хранятся на стороне Xsolla и задаются на уровне конкретного товара в Личном кабинете или через объект limits в следующих методах API:

Информация о лимитах возвращается в объекте items.limits в методах получения каталога товаров:

Методы подраздела Управление из группы методов Лимиты позволяют получать информацию о текущем состоянии лимитов и изменять их для конкретного пользователя — например, сбрасывать счетчик после выполнения квеста или корректировать остаток вручную.

Примечание

Подробная информация по настройке лимитов в каталоге приведена в разделе Лимиты на покупку товаров.

Управление

Операции

Admin

Операции

Предзаказы

Операции

Продавец

Операции

Catalog

Данный API позволяет получать продаваемые товары любого вида или конкретный товар.

Операции

Общие регионы

Операции

Admin

Операции

Admin

Операции

Catalog

Операции