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

Получение списка продуктов из продуктового каталога

Метод позволяет получить список потребляемых и\или непотребляемых товаров, доступных в приложении, включающий сведения об условиях оплаты этих продуктов.

подсказка

Если не знаете с чего начать, прочтите инструкцию в сценариях использования.

Параметры взаимодействия

GET
https://public-api.rustore.ru/public/applications/{appId}/catalog/products
АтрибутТипОписаниеОбязательностьРасположениеПример
Public-TokenstringJwe-токен авторизации в Public API Rustore.
Как получить токен авторизации.
ДаheaderN/A
appIdintИдентификатор приложения.Даpath385727
productIdstringИдентификатор продукта из консоли RuStore. Если задан, то возвращается информация только по продукту с указанным идентификатором.Нетquerygreen_crystal_0_1
productTypearrayТип продукта, допустимые значения:
  • consumable — потребляемые продукты;
  • non-consumable — непотребляемые продукты.
Даqueryconsumable
statusarrayСтатус публикации продукта:
  • active — опубликован в консоли RuStore;
  • inactive — не опуликован в консоли RuStore.
Нетqueryactive
continuationTokenstringТокен для получения следующей части результата.НетqueryMSxiYTBmZDA...4ZDMyOWNlOTY=
limitintКоличество элементов на странице. Максимальное значение 500.Нетquery20

Параметры ответа

АтрибутТипОписаниеОбязательностьПример
codestringДаКод ответа.ОК;
ERROR;
BAD_REQUEST;
NOT_FOUND.
messagestringНетРасшифровка кода ответа.N/A
body{}objectДаТело ответа.N/A
timestampstringДаВремя ответа.2024-11-01T11:10:54.994306Z

body{}

АтрибутТипОписаниеОбязательностьПример
totalElementsCountintОбщее количество элементов. Если элементы отсутствуют, вернётся значение 0.Нет500
elementsCountintКоличество возвращенных элементов.Нет20
continuationTokenstringТокен для получения следующей части результата.Нет, может вернуться nullnull
elements[]arrayСодержимое ответаНетMSxiYTBmZDA1MC01YWVmLTQ0YzItYTg3ZS00ZTM4ZDMyOWNlOTY=

elements[]

АтрибутТипОписаниеОбязательностьПример
productIdstringКод продукта.Нет, если нет возвращаемых элементов.green_crystal_0_1
productTypestringТип продукта, допустимые значения:
  • non-consumable — потребляемые продукты;
  • consumable — непотребляемые продукты.
Нет, если нет возвращаемых элементовconsumable
imagestringСсылка на картинку продукта.Нет, если нет возвращаемых элементовhttps://platform...c8e1b74.png
namestringНаименование продукта.Нет, если нет возвращаемых элементовЗелёные кристаллы
descriptionstringОписание продукта.Нет, если нет возвращаемых элементовЗёленые кристаллы для восстановления маны.
statusСтатус публикации продукта:
  • active — опубликован в консоли RuStore;
  • inactive — не опуликован в консоли RuStore.
Нет, если нет возвращаемых элементовactive
tariffs[]arrayТарифы.Нет, если нет возвращаемых элементовN/A

tariffs[]

АтрибутТипОписаниеОбязательностьПример
tariffCodestringКод тарифа приложения: standard — базовый.Нетstandard
namestringНаименование тарифа: Базовый.НетБазовый
priceCurrencystringКод валюты ISO 4217.НетRUB
priceValuestringСтоимость в минимальных единицах валюты (в копейках).Нет15000

Пример успешного ответа

{
"code": "OK",
"message": null,
"body": {
"totalElementsCount": 1,
"elementsCount": 1,
"continuationToken": null,
"elements": [
{
"productId": "green_crystal_0_1",
"productType": "subscription",
"image": ":image",
"name": "Зеленые кристаллы",
"description": "Зелёные кристаллы для восстановления маны",
"status": "active",
"tariffs": [
{
"tariffCode": "standard",
"name": "Базовый",
"priceCurrency": "RUB",
"priceValue": 15000,
}
]
}
]
},
"timestamp": "2024-11-01T11:10:54.994306Z"
}