Enrich Product

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)

import Channel3 from '@channel3/sdk';

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

const response = await client.enrich.enrichURL({ url: 'url' });

console.log(response.id);

curl --request POST \
  --url https://api.trychannel3.com/v0/enrich \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "<string>"
}
'

{
  "id": "<string>",
  "title": "<string>",
  "url": "<string>",
  "price": {
    "price": 123,
    "currency": "<string>",
    "compare_at_price": 123
  },
  "description": "<string>",
  "brands": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "images": [],
  "categories": [
    "<string>"
  ],
  "category": {
    "slug": "<string>",
    "title": "<string>",
    "has_children": true,
    "path": [
      {
        "slug": "<string>",
        "title": "<string>"
      }
    ]
  },
  "materials": [
    "<string>"
  ],
  "key_features": [
    "<string>"
  ],
  "offers": [
    {
      "url": "<string>",
      "domain": "<string>",
      "price": {
        "price": 123,
        "currency": "<string>",
        "compare_at_price": 123
      },
      "max_commission_rate": 0,
      "dimensions": {
        "length": {
          "number": 123
        },
        "width": {
          "number": 123
        },
        "height": {
          "number": 123
        },
        "weight": {
          "number": 123
        }
      }
    }
  ],
  "variants": {
    "options": [
      {
        "name": "<string>",
        "values": [
          {
            "label": "<string>",
            "exists": true,
            "thumbnail_url": "<string>",
            "product_id": "<string>"
          }
        ]
      }
    ],
    "selected": [
      {
        "name": "<string>",
        "label": "<string>"
      }
    ]
  },
  "structured_attributes": {},
  "brand_id": "<string>",
  "brand_name": "<string>",
  "image_urls": []
}

POST

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)

import Channel3 from '@channel3/sdk';

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

const response = await client.enrich.enrichURL({ url: 'url' });

console.log(response.id);

curl --request POST \
  --url https://api.trychannel3.com/v0/enrich \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "<string>"
}
'

{
  "id": "<string>",
  "title": "<string>",
  "url": "<string>",
  "price": {
    "price": 123,
    "currency": "<string>",
    "compare_at_price": 123
  },
  "description": "<string>",
  "brands": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "images": [],
  "categories": [
    "<string>"
  ],
  "category": {
    "slug": "<string>",
    "title": "<string>",
    "has_children": true,
    "path": [
      {
        "slug": "<string>",
        "title": "<string>"
      }
    ]
  },
  "materials": [
    "<string>"
  ],
  "key_features": [
    "<string>"
  ],
  "offers": [
    {
      "url": "<string>",
      "domain": "<string>",
      "price": {
        "price": 123,
        "currency": "<string>",
        "compare_at_price": 123
      },
      "max_commission_rate": 0,
      "dimensions": {
        "length": {
          "number": 123
        },
        "width": {
          "number": 123
        },
        "height": {
          "number": 123
        },
        "weight": {
          "number": 123
        }
      }
    }
  ],
  "variants": {
    "options": [
      {
        "name": "<string>",
        "values": [
          {
            "label": "<string>",
            "exists": true,
            "thumbnail_url": "<string>",
            "product_id": "<string>"
          }
        ]
      }
    ],
    "selected": [
      {
        "name": "<string>",
        "label": "<string>"
      }
    ]
  },
  "structured_attributes": {},
  "brand_id": "<string>",
  "brand_name": "<string>",
  "image_urls": []
}

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.

string

required

title

string

required

url

string

required

deprecated

Deprecated, use offers field

price

Price · object

required

deprecated

Deprecated, use offers field

Show child attributes

availability

enum<string>

required

deprecated

Deprecated, use offers field

Available options:

InStock,

OutOfStock

description

string | null

brands

ProductBrand · object[]

Ordered list of brands.

Show child attributes

images

LegacyInternalProductImage · object[]

Show child attributes

Models

Product

Brands

Categories

Websites

Price Tracking

Authorizations

Body

Response