Skip to main content
POST
/
v0
/
enrich
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.enrich.enrich_url(
    url="url",
)
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>",
  "brands": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "image_urls": [],
  "images": [],
  "categories": [],
  "gender": "male",
  "materials": [
    "<string>"
  ],
  "key_features": [
    "<string>"
  ],
  "variants": []
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
url
string
required

The URL of the product to enrich

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
deprecated
​
brand_name
string | null
deprecated
​
brands
ProductBrand · object[]

Ordered list of brands.

​
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[]