Skip to main content
GET
/
v0
/
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>",
  "url": "<string>",
  "title": "<string>",
  "price": {
    "price": 123,
    "currency": "<string>",
    "compare_at_price": 123
  },
  "availability": "InStock",
  "description": "<string>",
  "brand_id": "<string>",
  "brand_name": "<string>",
  "image_urls": [],
  "images": [],
  "categories": [],
  "gender": "male",
  "materials": [
    "<string>"
  ],
  "key_features": [
    "<string>"
  ],
  "variants": []
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
product_id
string
required

Query Parameters

​
redirect_mode
enum<string> | null

Optional redirect mode "price" redirects to the product page with the lowest price "commission" redirects to the product page with the highest commission rate "brand" redirects to the brand's product page

Available options:
brand,
price,
commission
​
website_ids
string[] | null

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

Response

Successful Response

A product with detailed information

​
id
string
required
​
url
string
required
​
title
string
required
​
price
Price · object
required
​
availability
enum<string>
required
Available options:
InStock,
LimitedAvailability,
PreOrder,
BackOrder,
SoldOut,
OutOfStock,
Discontinued,
Unknown
​
description
string | null
​
brand_id
string | null
​
brand_name
string | null
​
image_urls
string[]
deprecated

List of image URLs (deprecated, use images field)

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