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

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

Операции

Скидки

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

Операции

Бонусы

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

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

Получение информации об апселле в проектеServer-sideAdmin

Запрос

Возвращает информацию об апселле в проекте: включен или выключен апселл, какой тип апселла используется, а также список товаров, используемых в апселле.

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

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

Пример: 44056
curl -i -X GET \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/items/upsell \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Ответы

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

Телоapplication/jsonArray [
is_enabledboolean

Используется ли апселл в проекте.

Пример: true
itemsArray of objects

Список артикулов товаров, которые входят в апселл в проекте.

Пример: [{"item_id":1,"name":{"de":"Name des Artikels","en":"Item's name"},"sku":"com.xsolla.booster_mega_1","type":"virtual_good"}]
typestring

Тип апселла.

Перечисление"fixed_list""most_sellable""only_promotions"
Пример: "fixed_list"
]
Ответ
application/json
[ { "is_enabled": true, "items": [], "type": "fixed_list" } ]

Создание апселлаServer-sideAdmin

Запрос

Создает апселл в проекте.

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

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

Пример: 44056
Телоapplication/json
One of:

Тип апселла.

is_enabledboolean(is_enabled)обязательный
Пример: true
itemsArray of stringsобязательный

Массив артикулов товаров

По умолчанию null
Пример: ["game_sku"]
typestringобязательный
Значение"fixed_list"
Пример: true
curl -i -X POST \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/items/upsell \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": true,
    "items": [
      "game_sku_1",
      "game_sku_2",
      "game_sku_3"
    ],
    "type": "fixed_list"
  }'

Ответы

Апселл создан в проекте.

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

Обновление апселлаServer-sideAdmin

Запрос

Обновляет апселл в проекте.

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

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

Пример: 44056
Телоapplication/json
One of:

Тип апселла.

is_enabledboolean(is_enabled)обязательный
Пример: true
itemsArray of stringsобязательный

Массив артикулов товаров

По умолчанию null
Пример: ["game_sku"]
typestringобязательный
Значение"fixed_list"
Пример: true
curl -i -X PUT \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/items/upsell \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": true,
    "items": [
      "game_sku_1",
      "game_sku_2",
      "game_sku_3"
    ],
    "type": "fixed_list"
  }'

Ответы

Апселл обновлен в проекте.

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