Retrieving products list from the product catalog

This method allows retrieving a list of consumable or non-consumable products available in your app — including payment conditions for those products.

tip

If you are in doubt read the instruction in the usage scenarios.

Interaction parameters

GET

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

Attribute	Type	Description	Mandatory	Location	Example
Public-Token	string	Jwe token to Public API Rustore. How to get an authorization token.	Yes	header	N/A
appId	int	App ID	Yes	path	385727
productId	string	Product ID form the RuStore Console. If specified, only the information about the product with the specified ID is returned.	No	query	green_crystal_0_1
productType	array	Product type, available values: consumable; non-consumable.	Yes	query	consumable
status	array	Product publication status: active — published in the RuStore Console; inactive — not published in the RuStore Console.	No	query	active
continuationToken	string	Token to retrieve the next part of the result.	No	query	MSxiYTBmZDA...4ZDMyOWNlOTY=
limit	int	Number of elements on a page. Maximum value is 500.	No	query	20

Response parameters

Attribute	Type	Description	Mandatory	Example
code	string	Yes	Response code	• OK; • ERROR; • BAD_REQUEST; • NOT_FOUND.
message	string	No	Decoded response code	N/A
body{}	object	Yes	Response body	N/A
timestamp	string	Yes	Response time	2024-11-01T11:10:54.994306Z

body{}

Attribute	Type	Description	Mandatory	Example
totalElementsCount	int	Total number of elements. If there are no elements, 0 will be returned.	No	500
elementsCount	int	Number of returned elements.	No	20
continuationToken	string	Token to retrieve the next part of the result.	No, nullable	null
elements[]	array	Response contents	No	MSxiYTBmZDA1MC01YWVmLTQ0YzItYTg3ZS00ZTM4ZDMyOWNlOTY=

elements[]

Attribute	Type	Description	Mandatory	Example
productId	string	Product code.	No, if there are no returned elements.	green_crystal_0_1
productType	string	Product type, available values: non-consumable; consumable.	No, if there are no returned elements	consumable
image	string	Link to product picture	No, if there are no returned elements	https://platform...c8e1b74.png
name	string	Product name.	No, if there are no returned elements	Green crystals
description	string	Product description.	No, if there are no returned elements	Green crystals to regain mana.
status		Product publication status: active — published in the RuStore Console; inactive — not published in the RuStore Console.	No, if there are no returned elements	active
tariffs[]	array	Tariffs.	No, if there are no returned elements	N/A

tariffs[]

Attribute	Type	Description	Mandatory	Example
tariffCode	string	Tariff code: standard.	No	standard
name	string	Tariff name: Standard.	No	Standard
priceCurrency	string	ISO 4217 currency code.	No	RUB
priceValue	string	Price in minor currency units.	No	15000

Successful response

{
  "code": "OK",
  "message": null,
  "body": {
    "totalElementsCount": 1,
    "elementsCount": 1,
    "continuationToken": null,
    "elements": [
      {
        "productId": "green_crystal_0_1",
        "productType": "subscription",
        "image": ":image",
        "name": "Green crystals",
        "description": "Green crystals to regain mana",
        "status": "active",
        "tariffs": [
          {
            "tariffCode": "standard",
            "name": "Standard",
            "priceCurrency": "RUB",
            "priceValue": 15000,
          }
        ]
      }
    ]
  },
  "timestamp": "2024-11-01T11:10:54.994306Z"
}