Перейти к содержимому

Overview

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

Shop Builder API provides a third-party solution for implementing the server side for your store interface. Use the endpoints to manage in-game items, in-game currencies, cart, player inventory, promotions, game library, etc.

Скачать описание OpenAPI
Языки
Серверы
Mock server
https://xsolla.redocly.app/_mock/ru/api/shop-builder/
https://store.xsolla.com/api/
Операции

Персонализированный каталог

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

Узнать о персонализированных акциях можно в подразделе "Скидки" раздела "Акции".

Чтобы передать атрибуты перед покупкой, вы можете использовать API Авторизации Иксолла или передать их в свойство user.attributes при генерации токена с помощью API Платежей Иксолла.

Операции
Операции
Операции

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

Операции

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

Операции

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

Операции

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

Операции
Операции
Операции
Операции
Операции
Операции

Catalog

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

Операции
Операции
Операции
Операции
Операции
Операции

Купоны

Этот API позволяет вам управлять купонами.

Операции

Получение ограничений для уникальных кодов купоновServer-sideAdmin

Запрос

Возвращает оставшееся количество применений кодов. Для фильтрации кодов используйте параметр запроса codes.

Для настройки самого ограничения кода перейдите в раздел администратора:

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

ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.

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

External ID акции. Уникальный идентификатор акции в рамках проекта.

Пример: coupon_44056_1
Запрос
codes[]Array of strings

Уникальные коды, чувствительные к регистру. Содержат только буквы и цифры.

limitinteger>= 1

Лимит количества элементов на странице.

Пример: limit=50
offsetinteger>= 0

Номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0).

Пример: offset=0
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/code/limit/coupon/external_id/coupon_44056_1?codes%5B%5D=string&limit=50&offset=0'

Ответы

Успешно получены ограничения купона.

Телоapplication/json
has_moreboolean

Существует ли другая страница с кодами.

itemsArray of objects(Code-limit-promo-code)
promotion_idinteger

ID акции. Уникальный идентификатор акции в рамках проекта.

total_items_countnumber

Общее количество кодов.

Ответ
application/json
{ "has_more": false, "items": [ {}, {} ], "promotion_id": 1, "total_items_count": 2 }

Активация акции с купонамиServer-sideAdmin

Запрос

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

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

ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.

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

External ID акции. Уникальный идентификатор акции в рамках проекта.

Пример: coupon_44056_1
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/coupon/coupon_44056_1/activate

Ответы

Купон успешно активирован.

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

Получение кодов купоновServer-sideAdmin

Запрос

Получает коды купонов.

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

ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.

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

External ID акции. Уникальный идентификатор акции в рамках проекта.

Пример: coupon_44056_1
Запрос
limitinteger>= 1

Лимит количества элементов на странице.

Пример: limit=50
offsetinteger>= 0

Номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0).

Пример: offset=0
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/coupon/coupon_44056_1/code?limit=50&offset=0'

Ответы

Список кодов для купона успешно получен.

Телоapplication/json
codesArray of objects
total_countnumber

Общее количество кодов для купона.

Ответ
application/json
{ "codes": [ {}, {}, {}, {}, {} ], "total_count": 5 }

Промокоды

Этот API позволяет вам управлять промокодами.

Операции

Уникальный каталог предложений

Этот API позволяет вам управлять уникальными предложениями каталога.

Операции

Скидки

Этот API позволяет вам управлять скидочными акциями.

Операции

Бонусы

Этот API позволяет вам управлять бонусными акциями.

Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции