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
)
response = client.enrich.enrich_url(
    url="url",
)
print(response.id)
{
  "id": "<string>",
  "title": "<string>",
  "url": "<string>",
  "price": {
    "price": 123,
    "currency": "<string>",
    "compare_at_price": 123
  },
  "availability": "InStock",
  "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
    }
  ],
  "brand_id": "<string>",
  "brand_name": "<string>",
  "image_urls": [],
  "variants": []
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
url
string
required

The URL of the product to enrich

Response

Successful Response

v0 product detail with deprecated fields.

​
id
string
required
​
title
string
required
​
url
string
required
deprecated

Deprecated, use offers field

​
price
Price · object
required
deprecated

Deprecated, use offers field

​
availability
enum<string>
required
deprecated

Deprecated, use offers field

Available options:
InStock,
OutOfStock
​
description
string | null
​
brands
ProductBrand · object[]

Ordered list of brands.

​
images
LegacyInternalProductImage · 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.

​
brand_id
string | null
deprecated
​
brand_name
string | null
deprecated
​
image_urls
string[]
deprecated

List of image URLs (deprecated, use images field)

​
variants
Variant · object[]
deprecated

Legacy variant list, always empty. Use v1 API for variant dimensions.