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

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

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

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

Операции

Удаление товара из текущей корзиныClient-side

Запрос

Удаляет товар из корзины.

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

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

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

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

Пример: booster_mega_1
curl -i -X DELETE \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/cart/item/booster_mega_1 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Ответы

Товар успешно удален из корзины.

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

Обновление товара из текущей корзиныClient-side

Запрос

Обновляет уже имеющийся в корзине товар или создает его в корзине.

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

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

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

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

Пример: booster_mega_1
Телоapplication/json
quantitynumber

Количество товаров.

По умолчанию 123
curl -i -X PUT \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/cart/item/booster_mega_1 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "quantity": 123
  }'

Ответы

Корзина успешно обновлена.

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

Получение корзины по ID корзиныClient-side

Запрос

Возвращает корзину пользователя по ID корзины.

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

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

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

ID корзины.

Пример: custom_id
Запрос
currencystring

Валюта, в которой указаны цены товаров в корзине. Трехбуквенный код валюты в соответствии с ISO 4217. Подробную информацию о валютах, поддерживаемых Xsolla, смотрите в документации.

По умолчанию "USD"
localestring

Язык ответа. Двухбуквенный код языка в нижнем регистре в соответствии с ISO 639-1.

По умолчанию "en"
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/cart/custom_id?currency=USD&locale=en' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Ответы

Корзина с товарами успешно возвращена.

Телоapplication/json
cart_idstring

ID корзины.

Пример: "cart_id"
is_freeboolean(value-cart_is_free)

Если true, корзина бесплатная.

По умолчанию false
Пример: false
itemsArray of objects
priceobject or null

Цена корзины.

Пример: {"amount":"6150.0000000000000000","amount_without_discount":"6150.0000000000000000","currency":"USD"}
promotionsArray of objects(Catalog_cart_promotions)

Примененные ко всей корзине акции. Массив возвращается, если:

  • Акция влияет на общую стоимость корзины при использовании промокода с настройкой Скидка на покупку.

  • К корзине добавляются бонусные товары.

Если акции на уровне заказа не применялись, возвращается пустой массив.

Ответ
application/json
{ "cart_id": "cart_id", "is_free": false, "items": [ {} ], "price": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "promotions": [ {} ] }

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

Операции

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

Операции

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

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

Catalog

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

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

Купоны

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

Операции

Промокоды

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

Операции

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

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

Операции

Скидки

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

Операции

Бонусы

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

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