GET
/
product
/
{product_code}
Get product details
curl --request GET \
  --url https://playground.runa.io/v2/product/{product_code} \
  --header 'X-Api-Key: <api-key>'
{
  "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"
    }
  }
}
Returns a single product by its code, e.g. XYZ-US. 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. This endpoint supports returning product content in different formats. See the content parameter for more details.

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.

Path Parameters

​
product_code
string
required

The code of the product.

Query Parameters

​
content
enum<string>
default:url

Defines the format for product content resources.

  • url (default) for external URLs to markdown content
  • md for Markdown content in the response
  • html for rendered HTML in the response
Available options:
url,
md,
html

Response

OK

Product details

​
name
string
required

The name of the product.

Example:

"Example Merchant"

​
code
string
required

A unique code identifying the product. Use this code when placing an order.

For subscription products, this code identifies the top level product. You must use the subscription_plan_code instead when ordering.

Example:

"XYZ-US"

​
currency
string
required

The currency of the product, represented by an ISO 4217 currency code. See currencies for a list of supported currencies.

Example:

"USD"

​
state
enum<string>
required

The current state of the product.

Available options:
LIVE,
TEMPORARILY_DISABLED,
TEMPORARILY_DEGRADED
Example:

"LIVE"

​
is_orderable
boolean
required

Indicates whether or not you are able to order the product. You should use this detail to determine whether or not to display the product to your end users.

We recommend that you only display products to customers when this field is true - we will reject any orders placed for products where this is false. You can filter by is_orderable to only return products that can be ordered in the list endpoint.

​
payout_type
enum<string>
required

The type of payout - this field will tell you the key of the additional object details that correspond to each payout type. The types currently supported are gift_card, subscription, or payment. Your implementation should account for additional payout types being addedin the future.

Available options:
gift_card,
subscription,
payment
​
categories
string[]
required

List of the categories that the product belongs to. You can fetch the list of categories using the GET /product/categories endpoint.

Example:
["food-and-drink", "entertainment"]
​
countries_redeemable_in
string[]
required

Countries where the payout can be spent.

ISO 3166 ALPHA-2 country code

Example:
["US"]
​
customer_service
object
required

Contact information for customer service related to the product. Suitable for displaying to the customer.

​
discount_multiplier
string
required

The discount multiplier used when ordering. 0 means no discount and 0.1 means 10% discount. The discount is applied on the price of the order item before any fees are applied.

Example:

"0.05"

​
availability
enum<string>

The availability type of the product.

Available options:
stocked,
realtime
Example:

"realtime"

​
gift_card
object

Specific details about the gift card product, only populated when the payout_type is gift_card.

​
subscription
object

Details about the subscription product, only populated when the payout_type is subscription.

​
payment
object

Details about the payment product, only populated when the payout_type is payment.