Product Detail - Channel3

Fetch a single product by ID with GET /v1/products/{product_id}. This endpoint is free — use it to refresh prices, availability, offers, and buy links after search or lookup. You get the full Product object, including images, offers, variants, and metadata.

Basic retrieve

Pass a product ID from search, lookup, or similar:

import Channel3 from "@channel3/sdk";

const client = new Channel3();
const product = await client.products.retrieve("2yh8WH5");

console.log(product.title);
console.log(product.offers.map((o) => o.domain));

from channel3_sdk import Channel3

client = Channel3()
product = client.products.retrieve("2yh8WH5")

print(product.title)
print([o.domain for o in product.offers])

curl https://api.trychannel3.com/v1/products/2yh8WH5 \
  -H "x-api-key: $CHANNEL3_API_KEY"

Constrain the buy URL

When a product has offers from multiple merchants, pass website_ids to prefer buy URLs from specific stores. Accepts website IDs or domains (e.g. "nike.com"):

const product = await client.products.retrieve("2yh8WH5", {
  website_ids: ["nike.com"],
});

product = client.products.retrieve("2yh8WH5", website_ids=["nike.com"])

curl "https://api.trychannel3.com/v1/products/2yh8WH5?website_ids=nike.com" \
  -H "x-api-key: $CHANNEL3_API_KEY"

Locale and units

Set language, country, and currency so offers and prices match the shopper’s market. Optionally set length_unit and weight_unit for dimensions. See Set Locale and Localization.

const product = await client.products.retrieve("2yh8WH5", {
  country: "GB",
  language: "en",
  currency: "GBP",
});

product = client.products.retrieve(
    "2yh8WH5",
    country="GB",
    language="en",
    currency="GBP",
)

curl "https://api.trychannel3.com/v1/products/2yh8WH5?country=GB&language=en&currency=GBP" \
  -H "x-api-key: $CHANNEL3_API_KEY"

Variants

To resolve a specific size/color (or other options), pass option_<OptionName>=<Label> query params. The response updates product fields and sets variants.selected to the effective selection. See Variants.

When to use it

Refresh at display time — cache product.id from search, then retrieve before showing price or buy links (Caching)
Hydrate variant availability — search results may omit live stock; detail fills in available
Deep links — look up a known product ID from your app or agent state

⌘I