- Получение списка всех акций
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/v2/project/{project_id}/promotion/code/{code}/verify
- https://store.xsolla.com/api/v2/project/{project_id}/promotion/code/{code}/verify
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/promotion/code/WINTER2021/verify \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "code": "WINTER2023", "rewards": { "bonus": [ … ], "is_selectable": true }, "type": "coupon" }
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/shop-builder/v3/project/{project_id}/admin/promotion
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion
- 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?limit=50&offset=0&enabled=0'{ "active_promotions_count": 3, "inactive_promotions_count": 2, "promotions": [ { … }, { … }, { … }, { … }, { … } ], "total_promotions_count": 5 }
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/shop-builder/v3/project/{project_id}/admin/promotion/redeemable/code/{code}
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion/redeemable/code/{code}
- 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/redeemable/code/WINTER2021Акция успешно получена.
Список товаров, на которые действует скидка по промокоду. Только для промокодов.
Уникальный ID акции. external_id может содержать только строчные и заглавные латинские буквы, цифры, тире и подчеркивания.
Название акции. Данный параметр должен содержать пары ключ/значение, где ключ — это локаль в формате "^[a-z]{2}-[A-Z]{2}$", значение — строка.
Периоды действия акции. Если указано больше одного периода, параметры date_from и date_until становятся обязательными.
Количество погашений по коду.
Ограничивает общее количество купонов.
Ограничивает общее количество купонов, погашаемых одним пользователем.
{ "bonus": [ { … } ], "external_id": "coupon_fall_hammer_2", "is_enabled": true, "name": { "en": "This is a Coupon code for Epic Fall Hammer", "ru": "Eto kod kupona на Epic Fall Hammer" }, "promotion_periods": [ { … }, { … } ], "redeem_code_limit": null, "redeem_total_limit": 99, "redeem_user_limit": 1 }