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

Catalog API (2.0.0)

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
index.json
index.yaml
Языки
Серверы
Mock server
https://xsolla.redocly.app/_mock/ru/api/catalog/
https://store.xsolla.com/api/

Admin

Операции

Catalog

Операции

Виртуальная оплата

Операции

Catalog

Операции

Владение играми

Операции

Admin

Операции

Admin

Операции

Catalog

Операции

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

Операции

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

Операции

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

Операции

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

Операции

Заказ

Операции

Бесплатные товары

Операции

Управление

Операции

Обновление всех лимитов на покупку для пользователяServer-sideAdmin

Запрос

Обновляет все лимиты на покупку для всех товаров для указанного пользователя, чтобы он мог приобрести эти товары снова.

API лимитов на покупку позволяет вам продавать товар в ограниченном количестве. Чтобы настроить лимиты покупок, перейдите в раздел Admin нужного типа товара:

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

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

Пример: 44056
Телоapplication/json
userobject(User-limit_user)обязательный
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$обязательный

External ID пользователя.

curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/44056/admin/user/limit/item/all \
  -H 'Content-Type: application/json' \
  -d '{
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Ответы

Лимиты успешно обновлены.

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

Уменьшение лимита доступных пользователю товаровServer-sideAdmin

Запрос

Уменьшает оставшееся количество товаров, доступных указанному пользователю в пределах установленного лимита.

API лимитов на покупку позволяет вам продавать товар в ограниченном количестве. Чтобы настроить лимиты покупок, перейдите в раздел Admin нужного типа товара:

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

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

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

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

Пример: booster_mega_1
Телоapplication/json
availableinteger(User-limit_available)>= 1обязательный

Оставшееся количество товаров для продажи или доступных акций для пользователя в пределах установленных ограничений.

userobject(User-limit_user)обязательный
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$обязательный

External ID пользователя.

curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/44056/admin/user/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "available": 1,
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Ответы

Ограничения на покупку для пользователя были успешно получены.

Телоapplication/json
per_userobject
Ответ
application/json
{
  "per_user": {
    "available": 9,
    "total": 10
  }
}

Получение лимита доступных пользователю товаровServer-sideAdmin

Запрос

Возвращает оставшееся количество товаров, доступных указанному пользователю, в пределах установленного ограничения.

User limit API позволяет вам продавать товар в ограниченном количестве. Чтобы настроить ограничения на покупку, перейдите в раздел Admin нужного типа товара:

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

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

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

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

Пример: booster_mega_1
Запрос
user_external_idstringобязательный

External ID пользователя

Пример: user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/44056/admin/user/limit/item/sku/booster_mega_1?user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f'

Ответы

Ограничения на покупку для пользователя были успешно получены.

Телоapplication/json
per_userobject
Ответ
application/json
{
  "per_user": {
    "available": 9,
    "total": 10
  }
}

Admin

Операции

Вебхуки

Операции

Предзаказы

Операции

Продавец

Операции

Catalog

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

Операции

Общие регионы

Операции

Admin

Операции