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

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 Платежей Иксолла.

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

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

Операции

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

Операции

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

Операции

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

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

Уменьшение лимита предзаказа товараServer-sideAdmin

Запрос

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

Pre-Order limit API позволяет продавать товар в ограниченном количестве. Для настройки самого предзаказа перейдите в раздел Admin желаемого товара:

Алиасы для данного эндпоинта:

  • /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}
Безопасность
basicAuth
Путь
project_idintegerобязательный

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

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

Артикул товара.

Пример: booster_mega_1
Телоapplication/json
quantityintegerобязательный

Количество для удаления.

curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/items/pre_order/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "quantity": 100000
  }'

Ответы

Указанное количество успешно удалено из лимита предзаказа.

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

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

Запрос

Возвращает ограничение на предзаказ товара.

Pre-Order limit API позволяет вам продавать товар в ограниченном количестве. Для настройки самого предварительного заказа перейдите в раздел администратора модуля нужного товара:

Aliases для этой конечной точки:

  • /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}
Безопасность
basicAuth
Путь
project_idintegerобязательный

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

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

Артикул товара.

Пример: booster_mega_1
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/items/pre_order/limit/item/sku/booster_mega_1

Ответы

Информация о лимите предзаказа товара успешно получена.

Телоapplication/json
availableinteger
Пример: 431
is_pre_order_limit_enabledboolean
Пример: true
item_idinteger
Пример: 1
reservedinteger
Пример: 13
skustring
Пример: "com.xsolla.item_1"
soldinteger
Пример: 556
Ответ
application/json
{ "available": 431, "is_pre_order_limit_enabled": true, "item_id": 1, "reserved": 13, "sku": "com.xsolla.item_1", "sold": 556 }

Увеличение лимита предзаказа товараServer-sideAdmin

Запрос

Добавляет количество к ограничению на предзаказ товара.

Pre-Order limit API позволяет вам продавать товар в ограниченном количестве. Для настройки самого предварительного заказа перейдите в раздел администратора модуля нужного товара:

Aliases для этой конечной точки: */v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}

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

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

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

Артикул товара.

Пример: booster_mega_1
Телоapplication/json
quantityintegerобязательный

Количество для добавления.

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/items/pre_order/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "quantity": 100000
  }'

Ответы

Указанное количество успешно добавлено к лимиту предзаказа.

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

Catalog

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

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

Купоны

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

Операции

Промокоды

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

Операции

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

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

Операции

Скидки

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

Операции

Бонусы

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

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