Skip to content
HeyX API

Get Product

Required scope: catalog:read

Returns one product by its stable ID, including inactive products. Prices are integer minor currency units. countryPrices exposes the country-specific rows used by CreateQuote; each row includes its country-derived currency. Inspect isActive before selling. Use ListProducts or product search to discover IDs.

Generated Reference
POST /public-api/publicapi.v1.Catalog/GetProduct

Returns a single catalog product by its stable identifier.

Request GetProductRequest
Response GetProductResponse

GetProductRequest

Field Type Description
id string Stable identifier of the product to fetch.

GetProductResponse

Field Type Description
product Product The requested product.

Related Types

Product

Field Type Description
id string
folder_id optional string
name string
description string
sku string
price_once optional int32
price_monthly optional int32
price_yearly optional int32
currency string
is_active bool
min_quantity optional int32
max_quantity optional int32
product_kind string
country_prices repeated ProductCountryPrice
vat_rate double Default VAT rate as a fraction (for example 0.21 for 21%).

ProductCountryPrice

Field Type
country_code string
currency string
price_once optional int32
price_once_max optional int32
price_monthly optional int32
price_monthly_max optional int32
price_yearly optional int32
price_yearly_max optional int32
vat_rate double

Request

Section titled “Request”
{
  "id": "<product-id>"
}

Response

Section titled “Response”
{
  "product": {
    "id": "<product-id>",
    "name": "Solar panel",
    "description": "430 W panel",
    "sku": "PV-430",
    "priceOnce": 18900,
    "currency": "EUR",
    "vatRate": 0.21,
    "countryPrices": [
      { "countryCode": "US", "currency": "USD", "priceOnce": 20500, "vatRate": 0 }
    ],
    "isActive": true,
    "minQuantity": 1,
    "productKind": "simple"
  }
}
HeyX API