Перейти к содержимому
/
Получение инвентаря текущ...

Shop Builder 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

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

Клиент

Операции

Расходование предметаClient-side

Запрос

Метод клиента. Расходует предмет из инвентаря текущего пользователя.

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

ID проекта.

По умолчанию 44056
Запрос
platformstring

Платформа публикации, на которой играет пользователь.

По умолчанию "xsolla"
Перечисление"playstation_network""xbox_live""xsolla""pc_standalone""nintendo_shop""google_play""app_store_ios""android_standalone""ios_standalone""android_other"
Телоapplication/json
quantitynumberобязательный

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

По умолчанию 1
Пример: 1
skustringобязательный

Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания.

По умолчанию "booster_mega_1"
Пример: "booster_mega_1"
curl -i -X POST \
  'https://xsolla.redocly.app/_mock/ru/api/deprecated/inventory/v2/project/{project_id}/user/inventory/item/consume?platform=playstation_network' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "quantity": 1,
    "sku": "booster_mega_1"
  }'

Ответы

Товар из инвентаря пользователя израсходован.

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

Получение инвентаря текущего пользователяClient-side

Запрос

Метод клиента. Получает инвентарь текущего пользователя.

Внимание

Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset.
Безопасность
XsollaLoginUserJWT
Путь
project_idintegerобязательный

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

Пример: 44056
Запрос
limitinteger>= 1

Лимит количества элементов на странице.

Пример: limit=50
offsetinteger>= 0

Номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0).

Пример: offset=0
platformstring

Платформа публикации, на которой играет пользователь.

По умолчанию "xsolla"
Перечисление"playstation_network""xbox_live""xsolla""pc_standalone""nintendo_shop""google_play""app_store_ios""android_standalone""ios_standalone""android_other"
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/ru/api/deprecated/inventory/v2/project/44056/user/inventory/items?limit=50&offset=0&platform=playstation_network' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Ответы

Инвентарь пользователя успешно получен.

Телоapplication/json
itemsArray of objects
Пример: [{"attributes":[],"description":"Big Rocket - short description","groups":[],"image_url":"https://picture.bigrocket.png","instance_id":null,"name":"Rocket","quantity":null,"remaining_uses":1,"sku":"com.xsolla.instanciated_item_1","type":"virtual_good","virtual_item_type":"non_consumable"},{"attributes":[],"description":"description","groups":[],"image_url":"http://image.png","instance_id":null,"name":"SHOTGUN FOR TRUE RAIDERS","quantity":2,"remaining_uses":1,"sku":"com.xsolla.shotgun_raider_1","type":"virtual_good","virtual_item_type":"non_consumable"},{"attributes":[{"external_id":"stack_size","name":"Stack size","values":[{"external_id":"stack_size_value_99c25352ab6e34a0e0755fc2a9daa7a76021dce2","value":5}]},{"external_id":"licensed","name":"Licensed","values":[{"external_id":"licensed_value_d75d8034dd2f82cb3d2789f5ec1837a6c350b505","value":true}]}],"description":null,"groups":[],"image_url":null,"instance_id":null,"name":"HEADPHONES","quantity":5,"remaining_uses":1,"sku":"com.xsolla.headphones_for_pro_1","type":"virtual_good","virtual_item_type":"non_consumable"},{"attributes":[],"description":null,"groups":[],"image_url":null,"instance_id":null,"name":"UNIQUE DIAMONDS","quantity":100,"remaining_uses":1,"sku":"com.xsolla.platform_currency_1","type":"virtual_currency"}]
Ответ
application/json
{
  "items": [
    { … },
    { … },
    { … },
    { … }
  ]
}

Получение для текущего пользователя предметов с ограниченным сроком действияClient-side

Запрос

Метод клиента. Получает для текущего пользователя предметы с ограниченным сроком действия.

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

ID проекта.

По умолчанию 44056
Запрос
platformstring

Платформа публикации, на которой играет пользователь.

По умолчанию "xsolla"
Перечисление"playstation_network""xbox_live""xsolla""pc_standalone""nintendo_shop""google_play""app_store_ios""android_standalone""ios_standalone""android_other"
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/ru/api/deprecated/inventory/v2/project/{project_id}/user/time_limited_items?platform=playstation_network' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Ответы

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

Телоapplication/json
itemsArray of objects
Пример: [{"amount":10,"description":"Ruble","image_url":"https://picture.bigrocket.png","name":"Ruble","sku":"com.xsolla.VC_1","type":"virtual_currency","virtual_item_type":"non_renewing_subscription"},{"amount":5000,"description":"Xsollar","image_url":"http://image.png","name":"Xsollar","sku":"com.xsolla.VC_2","type":"virtual_currency","virtual_item_type":"non_renewing_subscription"}]
Ответ
application/json
{
  "items": [
    { … },
    { … },
    { … }
  ]
}

Получение виртуального баланса текущего пользователяClient-side

Запрос

Метод клиента. Получает виртуальный баланс текущего пользователя.

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

ID проекта.

По умолчанию 44056
Запрос
platformstring

Платформа публикации, на которой играет пользователь.

По умолчанию "xsolla"
Перечисление"playstation_network""xbox_live""xsolla""pc_standalone""nintendo_shop""google_play""app_store_ios""android_standalone""ios_standalone""android_other"
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/ru/api/deprecated/inventory/v2/project/{project_id}/user/virtual_currency_balance?platform=playstation_network' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Ответы

Виртуальный баланс пользователя успешно получен.

Телоapplication/json
itemsArray of objects
Пример: [{"description":"The PLEX or “30-day Pilot's License EXtension” is a virtual item that represents 30 days of subscription time and can be bought for cash and then sold to other players for in-game ISK.","expired_at":1746057600,"image_url":"https://picture.bigrocket.png","name":"PLEX","sku":"com.xsolla.plex_1","status":"active","type":"virtual_good","virtual_item_type":"non_renewing_subscription"},{"description":"WoW token allows players to buy game time World of Warcraft for money and sell it for game gold at auction.","expired_at":1546304461,"image_url":"https://picture.bigrocket.png","name":"WoW Token","sku":"com.xsolla.token_1","status":"expired","type":"virtual_good","virtual_item_type":"non_renewing_subscription"}]
Ответ
application/json
{
  "items": [
    { … },
    { … }
  ]
}

Управление

Операции

Кроссплатформенный инвентарь

Операции