GET
/
product
List Products
curl --request GET \
  --url https://playground.runa.io/v2/product \
  --header 'X-Api-Key: <api-key>'
[
  {
    "code": "tFV1",
    "name": "FV One",
    "image_url": "<string>",
    "denomination_type": "open",
    "categories": [
      {
        "code": "department-stores",
        "name": "Department Stores"
      }
    ],
    "minimum_value": 1,
    "maximum_value": 10,
    "available_denominations": [
      5,
      10
    ],
    "discount_multiplier": 0.1,
    "price_multiplier": 0.9
  }
]

Authorizations

​
X-Api-Key
string
header
required

Headers

​
X-Api-Version
string

The dated version of the API, if not specified a default is used.

Query Parameters

​
country_code
string
required

Country code for which to return a list of products.

Response

Successful Response

​
code
string
required

Product identifier.

Example:

"tFV1"

​
name
string
required

Product name.

Example:

"FV One"

​
image_url
string
required

Product image url.

​
denomination_type
string
required

Product denomination type.

Example:

"open"

​
categories
ProductCategory · object[]
required

List of categories a given product belongs to.

​
discount_multiplier
number
required

The discount multiplier. For example, 0.1 is a 10% discount on the value of the product.

Example:

0.1

​
price_multiplier
number
required

The price multiplier multiplied by the value of the product will give you the price you will pay to purchase it.

Example:

0.9

​
minimum_value
number

Minimum order value for a given product.

Example:

1

​
maximum_value
number

Maximum order value for a given product.

Example:

10

​
available_denominations
number[]

List of suggested denomination values of a product.

Example:
[5, 10]