GET
/
product
curl --request GET \
  --url https://playground.runa.io/v2/product \
  --header 'X-Api-Key: <api-key>'
{
  "catalog": [
    {
      "approval_state": "REQUIRES_CUSTOMER_ACTION",
      "categories": [
        "<string>"
      ],
      "code": "<string>",
      "countries_redeemable_in": [
        "<string>"
      ],
      "currency": "<string>",
      "customer_service": {
        "phone_number": "<string>",
        "website_url": "<string>"
      },
      "discount_multiplier": "<string>",
      "name": "<string>",
      "state": "LIVE",
      "is_orderable": true,
      "payout_type": "<string>",
      "availability": "stocked",
      "gift_card": {
        "assets": {
          "card_image_url": "<string>",
          "icon_image_url": "<string>",
          "primary_color": "<string>"
        },
        "balance_check_url": "<string>",
        "content_resources": {
          "description_markdown_url": "<string>",
          "disclaimer_markdown_url": "<string>",
          "refund_policy_markdown_url": "<string>",
          "reissuance_policy_markdown_url": "<string>",
          "terms_buyer_markdown_url": "<string>",
          "terms_consumer_markdown_url": "<string>",
          "redemption_instructions_markdown_url": "<string>",
          "locale": "<string>"
        },
        "expiry": {
          "date_policy": "<string>",
          "in_months": 123,
          "type": "from-last-use"
        },
        "redeemable_at": "all",
        "website_url": "<string>",
        "barcode_format": "code-128",
        "e_code_usage_type": "undefined",
        "denominations": {
          "available_list": [
            "<string>"
          ],
          "maximum_value": "<string>",
          "minimum_value": "<string>",
          "type": "open"
        }
      },
      "subscription": {
        "assets": {
          "card_image_url": "<string>",
          "icon_image_url": "<string>",
          "primary_color": "<string>"
        },
        "balance_check_url": "<string>",
        "content_resources": {
          "description_markdown_url": "<string>",
          "disclaimer_markdown_url": "<string>",
          "refund_policy_markdown_url": "<string>",
          "reissuance_policy_markdown_url": "<string>",
          "terms_buyer_markdown_url": "<string>",
          "terms_consumer_markdown_url": "<string>",
          "redemption_instructions_markdown_url": "<string>",
          "locale": "<string>"
        },
        "expiry": {
          "date_policy": "<string>",
          "in_months": 123,
          "type": "from-last-use"
        },
        "redeemable_at": "all",
        "website_url": "<string>",
        "barcode_format": "code-128",
        "e_code_usage_type": "undefined",
        "subscription_plans": [
          {
            "length_unit": "DAYS",
            "length": 123,
            "name": "<string>",
            "price": "<string>",
            "subscription_plan_code": "<string>"
          }
        ]
      },
      "payment": {
        "assets": {
          "icon_image_url": "<string>",
          "primary_color": "<string>"
        },
        "denominations": {
          "maximum_value": "<string>",
          "minimum_value": "<string>"
        },
        "content_resources": {
          "description_markdown_url": "<string>",
          "disclaimer_markdown_url": "<string>",
          "refund_policy_markdown_url": "<string>",
          "reissuance_policy_markdown_url": "<string>",
          "terms_buyer_markdown_url": "<string>",
          "terms_consumer_markdown_url": "<string>",
          "redemption_instructions_markdown_url": "<string>",
          "locale": "<string>"
        }
      }
    }
  ],
  "pagination": {
    "cursors": {
      "after": "ZXhhbXBsZW9mYWN1cnNvcg==",
      "before": "ZXhhbXBsZW9mYWN1cnNvcg=="
    },
    "page": {
      "limit": 100
    }
  }
}

Authorizations

X-Api-Key
string
header
required

Your API key. See the API key page on details of how to generate and store your keys.

Headers

X-Api-Version
string

The dated version of the API, if not specified a default is used. See API versioning for more information.

Query Parameters

is_orderable
boolean

Filter by products which can be ordered. If true, returns only those which can be ordered, if false, returns all products.

code
string

Filter by product code

countries_redeemable_in
string[]

Filter by countries where a product can be redeemed in.

ISO 3166 ALPHA-2 country code

after
string

A cursor for use in pagination to return the next set of products. The before and after cursors are mutually exclusive (you can't use them at the same time).

before
string

A cursor for use in pagination to return the previous set of products. The before and after cursors are mutually exclusive (you can't use them at the same time).

limit
integer
default:500

A limit on the number of items to be returned.

Required range: 1 <= x <= 500

Response

200
application/json

List of products in your catalog

The response is of type object.