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

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

Catalog API предоставляет методы для управления каталогом вашего внутриигрового магазина и обработки покупок. Используйте методы для настройки виртуальных предметов, виртуальных валют, игровых ключей, бандлов, процессов корзины и оплаты, атрибутов товаров, а также для импорта товаров из внешних источников.

Скачать описание OpenAPI
Языки
Серверы
Mock server
https://xsolla.redocly.app/_mock/ru/api/catalog/
https://store.xsolla.com/api/
Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции

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

Операции

Получение корзины по 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/catalog/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": [ {} ] }

Удаление всех товаров из корзины по ID корзиныClient-side

Запрос

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

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

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

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

ID корзины.

Пример: custom_id
curl -i -X PUT \
  https://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/44056/cart/custom_id/clear \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Ответы

Корзина успешно очищена.

Наполнение определенной корзины товарамиClient-side

Запрос

Наполняет определенную корзину товарами. Если в корзине уже есть товар с тем же артикулом, существующая позиция товара будет заменен переданным значением.

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

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

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

ID корзины.

Пример: custom_id
Телоapplication/json
itemsArray of objectsобязательный

Список товаров.

Пример: [{"quantity":123,"sku":"com.xsolla.booster_mega_1"}]
items[].​quantitynumberобязательный
По умолчанию 123
items[].​skustringобязательный
По умолчанию "booster_mega_1"
curl -i -X PUT \
  https://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/44056/cart/custom_id/fill \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "items": [
      {
        "quantity": 123,
        "sku": "com.xsolla.booster_mega_1"
      }
    ]
  }'

Ответы

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

Тело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)

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

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

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

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

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

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

Операции

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

Операции

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

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

Catalog

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

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