Product Detail - Channel3

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)

import Channel3 from '@channel3/sdk';

const client = new Channel3({
  apiKey: process.env['CHANNEL3_API_KEY'], // This is the default and can be omitted
});

const productDetail = await client.products.retrieve('product_id');

console.log(productDetail.id);

{
  "id": "<string>",
  "title": "<string>",
  "description": "<string>",
  "brands": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "images": [],
  "category": {
    "slug": "<string>",
    "title": "<string>",
    "has_children": true,
    "path": [
      {
        "slug": "<string>",
        "title": "<string>"
      }
    ]
  },
  "gender": "male",
  "age": "newborn",
  "materials": [
    "<string>"
  ],
  "key_features": [
    "<string>"
  ],
  "offers": [
    {
      "url": "<string>",
      "domain": "<string>",
      "price": {
        "price": 123,
        "currency": "<string>",
        "compare_at_price": 123
      },
      "availability": "InStock",
      "condition": "new",
      "max_commission_rate": 0,
      "dimensions": {
        "length": {
          "number": 123,
          "unit": "mm"
        },
        "width": {
          "number": 123,
          "unit": "mm"
        },
        "height": {
          "number": 123,
          "unit": "mm"
        },
        "weight": {
          "number": 123,
          "unit": "mg"
        }
      }
    }
  ],
  "variants": {
    "options": [
      {
        "name": "<string>",
        "values": [
          {
            "label": "<string>",
            "exists": true,
            "available": "InStock",
            "thumbnail_url": "<string>",
            "product_id": "<string>"
          }
        ]
      }
    ],
    "selected": [
      {
        "name": "<string>",
        "label": "<string>"
      }
    ]
  },
  "structured_attributes": {}
}

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)

import Channel3 from '@channel3/sdk';

const client = new Channel3({
  apiKey: process.env['CHANNEL3_API_KEY'], // This is the default and can be omitted
});

const productDetail = await client.products.retrieve('product_id');

console.log(productDetail.id);

{
  "id": "<string>",
  "title": "<string>",
  "description": "<string>",
  "brands": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "images": [],
  "category": {
    "slug": "<string>",
    "title": "<string>",
    "has_children": true,
    "path": [
      {
        "slug": "<string>",
        "title": "<string>"
      }
    ]
  },
  "gender": "male",
  "age": "newborn",
  "materials": [
    "<string>"
  ],
  "key_features": [
    "<string>"
  ],
  "offers": [
    {
      "url": "<string>",
      "domain": "<string>",
      "price": {
        "price": 123,
        "currency": "<string>",
        "compare_at_price": 123
      },
      "availability": "InStock",
      "condition": "new",
      "max_commission_rate": 0,
      "dimensions": {
        "length": {
          "number": 123,
          "unit": "mm"
        },
        "width": {
          "number": 123,
          "unit": "mm"
        },
        "height": {
          "number": 123,
          "unit": "mm"
        },
        "weight": {
          "number": 123,
          "unit": "mg"
        }
      }
    }
  ],
  "variants": {
    "options": [
      {
        "name": "<string>",
        "values": [
          {
            "label": "<string>",
            "exists": true,
            "available": "InStock",
            "thumbnail_url": "<string>",
            "product_id": "<string>"
          }
        ]
      }
    ],
    "selected": [
      {
        "name": "<string>",
        "label": "<string>"
      }
    ]
  },
  "structured_attributes": {}
}

Authorizations

x-api-key

string

header

required

Headers

x-user-id

string | null

Optional user identifier to attribute clicks and sales to a user in your system. Channel3 appends it to buy URLs in the response.

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. Accepts website IDs or domains (e.g. "nike.com").

language

enum<string> | null

ISO 639-1 language code.

Available options:

en,

de,

fr,

it,

es,

nl,

sv,

fi,

pt,

cs,

el,

ro

country

enum<string> | null

ISO 3166-1 alpha-2 country code. Matches any country when unset; defaults to 'US' only when language and currency are also unset. ISO 3166-1 alpha-2 country code (plus the pan-region EU).

Available options:

US,

GB,

EU,

AU,

CA,

IE,

DE,

AT,

FR,

BE,

IT,

ES,

NL,

SE,

FI,

PT,

CZ,

GR,

RO

currency

enum<string> | null

ISO 4217 currency code.

Available options:

USD,

CAD,

AUD,

GBP,

EUR,

SEK,

CZK,

RON

length_unit

enum<string> | null

Preferred unit for length dimensions (length/width/height). When unset, dimensions are returned in the unit the merchant stated.

Available options:

mm,

cm,

m,

in,

ft

weight_unit

enum<string> | null

Preferred unit for weight dimensions. When unset, weight is returned in the unit the merchant stated.

Available options:

mg,

g,

kg,

oz,

lb

Response

Successful Response

Product with detailed information.

id

string

required

title

string

required

description

string | null

brands

ProductBrand · object[]

Ordered list of brands.

Show child attributes

images

ProductImage · object[]

Show child attributes

category

CategorySummary · object | null

The single category this product belongs to, as a structured CategorySummary (slug, title, path, has_children).

Show child attributes

gender

enum<string> | null

Product gender. 'unisex' is deprecated: coerced to None on input, never emitted.

Available options:

male,

female

age

enum<string> | null

Target age group. Age-agnostic products are typically returned as 'adult'.

Available options:

newborn,

infant,

toddler,

kids,

adult

materials

string[] | null

key_features

string[] | null

offers

ProductOffer · object[]

All merchant offers for this product in the requested locale.

Show child attributes

variants

Variants · object | null

Variant interaction state — options, selected. Absent when the product has no variations.

Show child attributes

structured_attributes

Structured Attributes · object

Structured attributes extracted for this product, keyed by attribute handle (e.g. 'color', 'material'). Values are the canonical allowed values for that handle.

Show child attributes