Skip to navigation

Product Model

Understanding the Channel3 product data model

Every product returned by the Channel3 API follows a consistent data model. This guide explains the key fields and how to use them.

Product

A Product represents a canonical product in the Channel3 catalog. Key fields include:

FieldTypeDescription
idstringUnique product identifier
namestringProduct name
descriptionstringProduct description
brandobjectBrand information (id, name)
categoryobjectCategory information (slug, name)
imagesarrayProduct images
offersarrayPurchase offers from different retailers
variantsarrayProduct variants (sizes, colors, etc.)

Offers

Each product may have multiple offers from different retailers:

FieldTypeDescription
priceobjectCurrent price (amount, currency)
availabilitystringInStock, OutOfStock, or LimitedAvailability
urlstringPurchase URL (short-lived — always fetch fresh)
website_idstringRetailer website identifier

Images

Product images include quality and type metadata:

FieldTypeDescription
urlstringImage URL
typestringImage type (e.g. product, lifestyle)
qualitystringImage quality rating

Variants

Products can have variants for different sizes, colors, and other options:

FieldTypeDescription
optionsarrayAvailable variant options
selected_optionsarrayCurrently selected variant combination