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 проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Идентификатор пользователя может быть передан с помощью JWT пользователя Авторизации Иксолла или токена доступа Платежей Иксолла).
Двухбуквенное обозначение страны в верхнем регистре согласно стандарту ISO 3166-1 alpha-2. Список стран, поддерживаемых Xsolla, приведен в документации.
Пример: country=US
Валюта, в которой указаны цены товаров в корзине. Трехбуквенный код в соответствии с ISO 4217. Подробную информацию о валютах, поддерживаемых Xsolla, смотрите в документации.
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/admin/project/{project_id}/cart/fill
- https://store.xsolla.com/api/v2/admin/project/{project_id}/cart/fill
- 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/admin/project/44056/cart/fill?locale=en' \
-H 'Content-Type: application/json' \
-H 'x-user-for: ACCESS_TOKEN/LOGIN_JWT' \
-H 'x-user-id: UNIQUE_ID' \
-d '{
"currency": "USD",
"items": [
{
"quantity": 2,
"sku": "com.xsolla.cup01"
},
{
"quantity": 1,
"sku": "com.xsolla.t-shirt01"
},
{
"quantity": 1,
"sku": "com.xsolla.cup01"
},
{
"quantity": 1,
"sku": "com.xsolla.hat01"
}
]
}'Корзина с товарами успешно возвращена.
ID корзины. Передается в виде параметра запроса к прокси-странице или в виде параметра пути в API методах оплаты.
Примененные ко всей корзине акции. Массив возвращается, если:
Акция влияет на общую стоимость корзины при использовании промокода с настройкой Скидка на покупку.
К корзине добавляются бонусные товары.
Если акции на уровне заказа не применялись, возвращается пустой массив.
{ "cart_id": "cart_id", "is_free": false, "items": [ { … }, { … }, { … } ], "price": { "amount": "15.97", "amount_without_discount": "22.96", "currency": "USD" }, "promotions": [ { … } ], "warnings": [ { … } ] }
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Идентификатор пользователя может быть передан с помощью JWT пользователя Авторизации Иксолла или токена доступа Платежей Иксолла).
Двухбуквенное обозначение страны в верхнем регистре согласно стандарту ISO 3166-1 alpha-2. Список стран, поддерживаемых Xsolla, приведен в документации.
Пример: country=US
Валюта, в которой указаны цены товаров в корзине. Трехбуквенный код в соответствии с ISO 4217. Подробную информацию о валютах, поддерживаемых Xsolla, смотрите в документации.
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/admin/project/{project_id}/cart/{cart_id}/fill
- https://store.xsolla.com/api/v2/admin/project/{project_id}/cart/{cart_id}/fill
- 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/admin/project/44056/cart/custom_id/fill?locale=en' \
-H 'Content-Type: application/json' \
-H 'x-user-for: ACCESS_TOKEN/LOGIN_JWT' \
-H 'x-user-id: UNIQUE_ID' \
-d '{
"currency": "USD",
"items": [
{
"quantity": 2,
"sku": "com.xsolla.cup01"
},
{
"quantity": 1,
"sku": "com.xsolla.t-shirt01"
},
{
"quantity": 1,
"sku": "com.xsolla.cup01"
},
{
"quantity": 1,
"sku": "com.xsolla.hat01"
}
]
}'Корзина с товарами успешно возвращена.
ID корзины. Передается в виде параметра запроса к прокси-странице или в виде параметра пути в API методах оплаты.
Примененные ко всей корзине акции. Массив возвращается, если:
Акция влияет на общую стоимость корзины при использовании промокода с настройкой Скидка на покупку.
К корзине добавляются бонусные товары.
Если акции на уровне заказа не применялись, возвращается пустой массив.
{ "cart_id": "cart_id", "is_free": false, "items": [ { … }, { … }, { … } ], "price": { "amount": "15.97", "amount_without_discount": "22.96", "currency": "USD" }, "promotions": [ { … } ], "warnings": [ { … } ] }