- Обновление акции с бонусами
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.
Персонализированный каталог
Данный API позволяет задавать правила для пользовательских атрибутов. Если пользователь соответствует всем условиям для конкретного правила, будут показаны персонализированные товары.
Узнать о персонализированных акциях можно в подразделе "Скидки" раздела "Акции".
Чтобы передать атрибуты перед покупкой, вы можете использовать API Авторизации Иксолла или передать их в свойство user.attributes при генерации токена с помощью API Платежей Иксолла.
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/shop-builder/v3/project/{project_id}/admin/promotion/{promotion_id}/bonus
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion/{promotion_id}/bonus
- 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/promotion/111425/bonusАкция с бонусами успешно получена.
Условия для проверки атрибутов пользователя. Определяют доступность акции на основе соответствия атрибутов пользователя всем указанным условиям.
Набор товаров, которые необходимо включить в покупку для применения акции. Если этот параметр равен null, акция будет применена к любым покупкам в рамках проекта.
Список акций, которые исключаются при применении этой акции.
Example: [12, 789]
Название акции. Данный параметр должен содержать пары ключ/значение, где ключ — это локаль в формате "^[a-z]{2}-[A-Z]{2}$", значение — строка.
Массив объектов с условиями, задающими ценовой диапазон применения акции.
Акция применяется только к товарам, цена которых удовлетворяет всем условиям в массиве. Если вы передаете этот массив, в объекте condition передайте значение null.
{ "bonus": [ { … }, { … }, { … } ], "condition": [ { … }, { … } ], "excluded_promotions": [ 23, 45 ], "id": 1, "is_enabled": true, "limits": { "per_item": null, "per_user": { … }, "recurrent_schedule": { … } }, "name": { "de-DE": "Neujahrsbonus", "en-US": "New Year Bonus" }, "price_conditions": [ { … }, { … } ], "promotion_periods": [ { … } ] }
Запрос
Обновляет акцию.
Новые данные заменят старые. Если вы хотите обновить только часть акции, вам также следует передать в запросе все необходимые данные.
Акция добавляет бесплатные бонусные товары к покупке, совершенной пользователем. Акция может быть применена к каждой покупке в рамках проекта или к покупке, включающей определенные товары.
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Условия для проверки атрибутов пользователя. Определяют доступность акции на основе соответствия атрибутов пользователя всем указанным условиям.
Набор товаров, которые необходимо включить в покупку для применения акции. Если этот параметр равен null, акция будет применена к любым покупкам в рамках проекта.
Список акций, которые исключаются при применении этой акции.
Example: [12, 789]
Название акции. Данный параметр должен содержать пары ключ/значение, где ключ — это локаль в формате "^[a-z]{2}-[A-Z]{2}$", значение — строка.
Массив объектов с условиями, задающими ценовой диапазон применения акции.
Акция применяется только к товарам, цена которых удовлетворяет всем условиям в массиве. Если вы передаете этот массив, в объекте condition передайте значение null.
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/shop-builder/v3/project/{project_id}/admin/promotion/{promotion_id}/bonus
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion/{promotion_id}/bonus
- 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/v3/project/44056/admin/promotion/111425/bonus \
-H 'Content-Type: application/json' \
-d '{
"attribute_conditions": [
{
"attribute": "account_status",
"can_be_missing": false,
"operator": "eq",
"type": "string",
"value": "golden"
}
],
"bonus": [
{
"quantity": 50000,
"sku": "com.xsolla.mp_credits"
}
],
"condition": [
{
"sku": "com.xsolla.year_1_season_pass"
}
],
"name": {
"de-DE": "Neujahrsbonus",
"en-US": "New Year Bonus"
},
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
]
}'