Lookup Product

Python

from channel3_sdk import Channel3
from channel3_sdk.environment import Channel3Environment

client = Channel3(
    api_key="<value>",
    environment=Channel3Environment.PRODUCTION,
)

client.products.lookup(
    url="url",
)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({url: '<string>'})
};

fetch('https://api.trychannel3.com/v1/lookup', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "product": {
    "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>"
    ],
    "colors": [
      {
        "hex": "<string>",
        "percentage": 123
      }
    ],
    "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": {},
    "ratings": {
      "value": 123,
      "count": 123,
      "source_count": 123
    }
  }
}

POST

lookup

Python

from channel3_sdk import Channel3
from channel3_sdk.environment import Channel3Environment

client = Channel3(
    api_key="<value>",
    environment=Channel3Environment.PRODUCTION,
)

client.products.lookup(
    url="url",
)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({url: '<string>'})
};

fetch('https://api.trychannel3.com/v1/lookup', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "product": {
    "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>"
    ],
    "colors": [
      {
        "hex": "<string>",
        "percentage": 123
      }
    ],
    "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": {},
    "ratings": {
      "value": 123,
      "count": 123,
      "source_count": 123
    }
  }
}

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.

Body

application/json

url

string

required

The URL of the product to look up

max_staleness_hours

integer

default:3

Maximum age (in hours) of cached product data before forcing a fresh lookup. Defaults to 3 hours.

Required range: x >= 1

realtime_fetch

boolean

default:true

Fetch the product page live when the URL is not in the Channel3 catalog or its data is older than max_staleness_hours. When false, only catalog products are returned: stale data is returned as-is, and URLs not in the catalog return 404.

Response

Successful Response

Response from the /v1/lookup endpoint.

product

Product · object

required

Product with detailed information.

Show child attributes

Products

Conversational Agent

Collections

Brands

Categories

Websites

Reporting

Price tracking

Models

Authorizations

Headers

Body

Response