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

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

подсказка

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

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

GET
https://public-api.rustore.ru/public/applications/{appId}/catalog/products

Атрибут	Тип	Описание	Обязательность	Расположение	Пример
`Public-Token`	string	Jwe-токен авторизации в Public API Rustore. Как получить токен авторизации.	Да	header	N/A
`appId`	number	Идентификатор приложения.	Да	path	`385727`
`productId`	string	Идентификатор продукта из RuStore консоли. Если задан, то возвращается информация только по продукту с указанным идентификатором.	Нет	query	`green_crystal_0_1`
`productType`	array	Тип продукта, допустимые значения: `consumable` — потребляемые продукты; `non-consumable` — непотребляемые продукты.	Да	query	`consumable`
`status`	array	Статус публикации продукта: `active` — опубликован в RuStore консоли; `inactive` — не опубликован в RuStore консоли.	Нет	query	`active`
`continuationToken`	string	Токен для получения следующей части результата.	Нет	query	`MSxiYTBmZDA...4ZDMyOWNlOTY=`
`limit`	number	Количество элементов на странице. Максимальное значение `500`.	Нет	query	`20`

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

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

`body{}`

Атрибут	Тип	Описание	Обязательность	Пример
`totalElementsCount`	number	Общее количество элементов. Если элементы отсутствуют, вернется значение `0`.	Нет	`500`
`elementsCount`	number	Количество возвращенных элементов.	Нет	`20`
`continuationToken`	string	Токен для получения следующей части результата.	Нет, может вернуться `null`	`null`
`elements[]`	array	Содержимое ответа	Нет	`MSxiYTBmZDA1MC01YWVmLTQ0YzItYTg3ZS00ZTM4ZDMyOWNlOTY=`

`elements[]`

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

`tariffs[]`

Атрибут	Тип	Описание	Обязательность	Пример
`tariffCode`	string	Код тарифа приложения: `standard` — базовый.	Нет	`standard`
`name`	string	Наименование тарифа: `Базовый`.	Нет	`Базовый`
`priceCurrency`	string	Код валюты ISO 4217.	Нет	`RUB`
`priceValue`	string	Стоимость в минимальных единицах валюты (в копейках).	Нет	`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"
}

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

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

body{}​

elements[]​

tariffs[]​

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