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

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 позволяет вам управлять купонами.

Операции

Промокоды

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

Операции

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

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

Операции

Создание уникального кода предложения по каталогуServer-sideAdmin

Запрос

Создает уникальный код предложения по каталогу.

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

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

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

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

Пример: coupon_44056_1
Телоapplication/json
coupon_codestring(Promotions_coupon_code)[ 1 .. 128 ] characters^[a-zA-Z0-9]+$

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

По умолчанию "WINTER2021"
Пример: "WINTER2021"
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/unique_catalog_offer/coupon_44056_1/code \
  -H 'Content-Type: application/json' \
  -d '{
    "coupon_code": "WINTER2021"
  }'

Ответы

Код успешно создан.

Телоapplication/json
codestring(Promotions_coupon_code)[ 1 .. 128 ] characters^[a-zA-Z0-9]+$

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

По умолчанию "WINTER2021"
Пример: "WINTER2021"
Ответ
application/json
{ "code": "WINTER2021" }

Генерация уникальных кодов предложений по каталогуServer-sideAdmin

Запрос

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

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

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

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

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

Пример: coupon_44056_1
Телоapplication/json
countinteger(Promotions_coupon-generate-count)[ 1 .. 100000 ]обязательный
Пример: 10
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/unique_catalog_offer/coupon_44056_1/code/generate \
  -H 'Content-Type: application/json' \
  -d '{
    "count": 10
  }'

Ответы

Коды были успешно сгенерированы.

Телоapplication/json
countinteger(Promotions_coupon-generate-count)[ 1 .. 100000 ]
Пример: 10
Ответ
application/json
{ "count": 10 }

Отключите уникальное акционное предложение по каталогу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/unique_catalog_offer/coupon_44056_1/deactivate

Ответы

Уникальное предложение по каталогу было успешно деактивировано.

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

Скидки

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

Операции

Бонусы

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

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