Value Point SKU.
- Настройка призовых баллов для товаров
Получение списка призовых баллов
Создание призовых баллов
Удаление призовых баллов
Получение призовых баллов
Обновление призовых баллов
Удаление призовых баллов с товаров
Получение списка товаров с призовыми баллами
Частичное обновление призовых баллов для товаров
Получение списка цепочек наград
Создание цепочек наград
Удаление цепочек наград
Получение цепочек наград
Обновление цепочек наград
Сброс цепочки наград
Переключение цепочки наград
Настройка призовых баллов...
Shop Builder 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
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 Платежей Иксолла.
Операции
Запрос
Частично обновляет количество призовых баллов для одного или нескольких товаров по артикулам этих товаров. Пользователи получают призовые баллы после покупки этих товаров.
Принципы обновления призовых баллов:
- Если у товара еще нет призовых баллов, отправка ненулевого значения в поле
amountсоздаст их. - Если у товара уже есть призовые баллы, отправка ненулевого значения в поле
amountобновит их. - Если в поле
amountпередано значение 0, существующие призовые баллы для этого товара будут удалены.
В отличие от метода PUT (Настройка призовых баллов для товаров), этот метод PATCH не перезаписывает все ранее установленные призовые баллы для товаров в проекте, а обновляет только указанные.
В одном запросе можно обновить до 100 товаров. В одном запросе нельзя передавать одинаковые артикулы товаров.
Безопасность
basicAuth
Путь
Телоapplication/jsonArray [ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Пример: 44056
Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания.
Пример: "booster_mega_1"
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/{project_id}/admin/items/{value_point_sku}/value_points/rewards
- https://store.xsolla.com/api/v2/project/{project_id}/admin/items/{value_point_sku}/value_points/rewards
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/items/value_point_3/value_points/rewards \
-H 'Content-Type: application/json' \
-d '[
{
"amount": 100,
"sku": "booster_1"
},
{
"amount": 0,
"sku": "booster_mega"
}
]'Запрос
Присваивает призовые баллы одному или нескольким товарам по артикулу. Пользователи получают призовые баллы после покупки этих товаров.
Обратите внимание, что этот запрос PUT перезаписывает все ранее установленные призовые баллы для товаров в проекте.
Чтобы избежать непреднамеренного удаления призовых баллов, включайте все товары и соответствующие им значения в каждый запрос PUT.
Если вы хотите обновить призовые баллы только для определенного товара, сохранив значения призовых баллов для других товаров, вам следует получить текущий набор призовых баллов с помощью запроса GET, изменить значения призовых баллов для желаемого товара, а затем отправить измененный набор призовых баллов обратно с обновленными значениями призовых баллов для конкретного товара.
Безопасность
basicAuth
Путь
Телоapplication/jsonArray [ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Пример: 44056
Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания.
Пример: "booster_mega_1"
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/{project_id}/admin/items/{value_point_sku}/value_points/rewards
- https://store.xsolla.com/api/v2/project/{project_id}/admin/items/{value_point_sku}/value_points/rewards
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/items/value_point_3/value_points/rewards \
-H 'Content-Type: application/json' \
-d '[
{
"amount": 100,
"sku": "com.xsolla.booster_1"
},
{
"amount": 200,
"sku": "com.xsolla.booster_mega"
}
]'Запрос
Получает список цепочек наград.
Внимание!
Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 10 товаров в ответе.Чтобы получить больше данных постранично, используйте поля limit и offset.
Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 10 товаров в ответе.Чтобы получить больше данных постранично, используйте поля limit и offset.
Безопасность
basicAuth
Путь
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Пример: 44056
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/shop-builder/v3/project/{project_id}/admin/reward_chain
- https://store.xsolla.com/api/v3/project/{project_id}/admin/reward_chain
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/ru/api/shop-builder/v3/project/44056/admin/reward_chain?limit=50&offset=0&enabled=0'Ответ
application/json
{ "has_more": true, "items": [ { … }, { … } ] }