Skip to main content
GET
/
v1
/
products
/
{product_id}
Python
import os
from channel3_sdk import Channel3

client = Channel3(
    api_key=os.environ.get("CHANNEL3_API_KEY"),  # This is the default and can be omitted
)
product_detail = client.products.retrieve(
    product_id="product_id",
)
print(product_detail.id)
{
  "id": "<string>",
  "title": "<string>",
  "description": "<string>",
  "brands": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "images": [],
  "categories": [],
  "gender": "male",
  "materials": [
    "<string>"
  ],
  "key_features": [
    "<string>"
  ],
  "offers": [
    {
      "url": "<string>",
      "domain": "<string>",
      "price": {
        "price": 123,
        "currency": "<string>",
        "compare_at_price": 123
      },
      "availability": "InStock",
      "max_commission_rate": 0
    }
  ]
}

Authorizations

x-api-key
string
header
required

Path Parameters

product_id
string
required

Query Parameters

website_ids
string[] | null

Optional list of website IDs to constrain the buy URL to, relevant if multiple merchants exist

Response

Successful Response

Product with detailed information.

id
string
required
title
string
required
description
string | null
brands
ProductBrand · object[]

Ordered list of brands.

images
ProductImage · object[]
categories
string[]
gender
enum<string> | null
Available options:
male,
female,
unisex
materials
string[] | null
key_features
string[] | null
offers
ProductOffer · object[]

All merchant offers for this product in the requested locale.