GET
/
product
List products
curl --request GET \
  --url https://playground.runa.io/v2/product \
  --header 'X-Api-Key: <api-key>'
{
  "catalog": [
    {
      "name": "Example Merchant",
      "code": "XYZ-US",
      "currency": "USD",
      "state": "LIVE",
      "is_orderable": true,
      "payout_type": "gift_card",
      "categories": [
        "food-and-drink",
        "entertainment"
      ],
      "countries_redeemable_in": [
        "US"
      ],
      "customer_service": {
        "phone_number": "+1234567890",
        "website_url": "https://merchant.example.com/customer-service"
      },
      "discount_multiplier": "0.05",
      "availability": "realtime",
      "gift_card": {
        "assets": {
          "card_image_url": "https://gift.runa.io/static/product_assets/XYZ-US/XYZ-US-card.png",
          "icon_image_url": "https://gift.runa.io/static/product_assets/XYZ-US/XYZ-US-icon.png",
          "primary_color": "#000000"
        },
        "balance_check_url": "https://merchant.example.com/balance-check",
        "content_resources": {
          "description_markdown_url": "https://d2abcdef.cloudfront.net/resources/XYZ-US/description.md",
          "disclaimer_markdown_url": "https://d2abcdef.cloudfront.net/resources/XYZ-US/disclaimer_markdown.md",
          "refund_policy_markdown_url": "https://d2abcdef.cloudfront.net/resources/XYZ-US/refund_policy_markdown.md",
          "reissuance_policy_markdown_url": "https://d2abcdef.cloudfront.net/resources/XYZ-US/reissuance_policy_markdown.md",
          "terms_buyer_markdown_url": "https://d2abcdef.cloudfront.net/resources/XYZ-US/terms_buyer.md",
          "terms_consumer_markdown_url": "https://d2abcdef.cloudfront.net/resources/XYZ-US/terms_consumer.md",
          "redemption_instructions_markdown_url": "https://d2abcdef.cloudfront.net/resources/XYZ-US/redeem_markdown.md",
          "locale": "en_US"
        },
        "expiry": {
          "date_policy": "Expires 2 years from issue date",
          "in_months": 12,
          "type": "from-issue-date"
        },
        "redeemable_at": "all",
        "website_url": "https://merchant.example.com",
        "barcode_format": "code-128",
        "e_code_usage_type": "url-only",
        "denominations": {
          "type": "fixed",
          "minimum_value": "10.00",
          "maximum_value": "100.00",
          "available_list": [
            "10.00",
            "20.00",
            "50.00",
            "100.00"
          ]
        }
      },
      "subscription": {
        "assets": {
          "card_image_url": "https://gift.runa.io/static/product_assets/XYZ-US/XYZ-US-card.png",
          "icon_image_url": "https://gift.runa.io/static/product_assets/XYZ-US/XYZ-US-icon.png",
          "primary_color": "#000000"
        },
        "balance_check_url": "https://merchant.example.com/balance-check",
        "content_resources": {
          "description_markdown_url": "https://d2abcdef.cloudfront.net/resources/XYZ-US/description.md",
          "disclaimer_markdown_url": "https://d2abcdef.cloudfront.net/resources/XYZ-US/disclaimer_markdown.md",
          "refund_policy_markdown_url": "https://d2abcdef.cloudfront.net/resources/XYZ-US/refund_policy_markdown.md",
          "reissuance_policy_markdown_url": "https://d2abcdef.cloudfront.net/resources/XYZ-US/reissuance_policy_markdown.md",
          "terms_buyer_markdown_url": "https://d2abcdef.cloudfront.net/resources/XYZ-US/terms_buyer.md",
          "terms_consumer_markdown_url": "https://d2abcdef.cloudfront.net/resources/XYZ-US/terms_consumer.md",
          "redemption_instructions_markdown_url": "https://d2abcdef.cloudfront.net/resources/XYZ-US/redeem_markdown.md",
          "locale": "en_US"
        },
        "expiry": {
          "date_policy": "Expires 2 years from issue date",
          "in_months": 12,
          "type": "from-issue-date"
        },
        "redeemable_at": "all",
        "website_url": "https://merchant.example.com",
        "barcode_format": "code-128",
        "e_code_usage_type": "url-only",
        "subscription_plans": [
          {
            "length_unit": "MONTHS",
            "length": 12,
            "name": "3 month subscription",
            "price": "10.00",
            "subscription_plan_code": "XYZ-US-SUB-1"
          }
        ]
      },
      "payment": {
        "assets": {
          "icon_image_url": "https://gift.runa.io/static/product_assets/XYZ-US/XYZ-US-icon.png",
          "primary_color": "#000000"
        },
        "denominations": {
          "minimum_value": "10.00",
          "maximum_value": "100.00"
        },
        "content_resources": {
          "description_markdown_url": "https://d2abcdef.cloudfront.net/resources/XYZ-US/description.md",
          "disclaimer_markdown_url": "https://d2abcdef.cloudfront.net/resources/XYZ-US/disclaimer_markdown.md",
          "refund_policy_markdown_url": "https://d2abcdef.cloudfront.net/resources/XYZ-US/refund_policy_markdown.md",
          "reissuance_policy_markdown_url": "https://d2abcdef.cloudfront.net/resources/XYZ-US/reissuance_policy_markdown.md",
          "terms_buyer_markdown_url": "https://d2abcdef.cloudfront.net/resources/XYZ-US/terms_buyer.md",
          "terms_consumer_markdown_url": "https://d2abcdef.cloudfront.net/resources/XYZ-US/terms_consumer.md",
          "redemption_instructions_markdown_url": "https://d2abcdef.cloudfront.net/resources/XYZ-US/redeem_markdown.md",
          "locale": "en_US"
        }
      }
    }
  ],
  "pagination": {
    "cursors": {
      "after": "A-789",
      "before": "A-123"
    },
    "page": {
      "limit": 100
    }
  }
}
Lists all products available for ordering in a paginated response. You can filter the products by country and category. This endpoint returns different payout types:
  • gift_card: A gift card is a payout that can be redeemed for a specific value.
  • subscription: A subscription is a payout that can be ordered for a specific duration.
  • payment: A payment is a payout that can be ordered for a specific value.
You should use the payout_type field to determine which object to use to extract details for the product. The different payout types have different fields, so you should use the appropriate object to extract the details you need.

Need help with the product catalog?

We have a guide to help you get started with the product catalog, including how to filter the catalog and the different payout types.

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.

​
countries_redeemable_in
string[]

Filter by countries where a product can be redeemed in. To specify multiple countries repeat the parameter for each country, e.g. ?countries_redeemable_in=US&countries_redeemable_in=GB. You can pull the list of supported countries from the list countries endpoint.

ISO 3166 ALPHA-2 country code

​
categories
string[]

Filter by product categories. To specify multiple categories repeat the parameter for each category, e.g. ?categories=fashion&categories=department-stores. You can pull the list of categories from the list categories endpoint.

Product category name

​
before
string

A cursor for use in pagination to return the previous set of results. The before and after cursors are mutually exclusive (you can't use them at the same time). You can get a value from the pagination.cursors.before field in the response. See pagination for more information.

Example:

"A-123"

​
after
string

A cursor for use in pagination to return the next set of results. The before and after cursors are mutually exclusive (you can't use them at the same time). You can get a value from the pagination.cursors.after field in the response. See pagination for more information.

Example:

"A-789"

​
limit
integer
default:500

A limit on the number of items to be returned. See pagination for more information on how to use this parameter.

Required range: 1 <= x <= 500

Response

List of products in your catalog

​
catalog
object[]
​
pagination
object

Information about the page of results returned. See pagination for more information on how to page through results.