Color

Find products that match one or more colors. This is useful for building color-matched shopping experiences — for example, finding brown couches or blue Dodger’s gear.

Color filtering is currently in Beta. The API surface may change.

Color search demo

Basic color filter

Add one or more colors to your search. Each color needs a hex code (like #5D3FD3).

import Channel3 from "@channel3/sdk";

const client = new Channel3();

const results = await client.products.search({
  query: "sofa",
  filters: {
    colors: {
      palette: [{ hex: "#5D3FD3" }],
    },
  },
});

from channel3_sdk import Channel3

client = Channel3()

results = client.products.search(
    query="sofa",
    filters={
        "colors": {"palette": [{"hex": "#5D3FD3"}]},
    },
)

curl -X POST https://api.trychannel3.com/v1/search \
  -H "x-api-key: $CHANNEL3_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "sofa",
    "filters": { "colors": { "palette": [{ "hex": "#5D3FD3" }] } }
  }'

Multiple colors

Provide a palette of colors to find products that match the combination. Every color in the palette must be present — it’s AND, not “red OR blue.”

const results = await client.products.search({
  query: "throw pillow",
  filters: {
    colors: {
      palette: [{ hex: "#1A1A2E" }, { hex: "#E2B96F" }],
    },
  },
});

results = client.products.search(
    query="throw pillow",
    filters={
        "colors": {
            "palette": [
                {"hex": "#1A1A2E"},
                {"hex": "#E2B96F"},
            ],
        },
    },
)

Color percentages

Use percentage for relative prominence when a product has multiple colors — which one dominates, and which are accents. It does not mean “80% of the image must be blue.” “Mostly blue, with a little brown” would look like:

TypeScript

const results = await client.products.search({
  query: "area rug",
  filters: {
    colors: {
      palette: [
        { hex: "#1E3A8A", percentage: 0.8 }, // dominant
        { hex: "#8B4513", percentage: 0.2 }, // accent
      ],
    },
  },
});

That tells the API a 4:1 ratio (more blue than brown). Omit percentage when you only care that all colors appear, not how they’re weighted (e.g. “red, white, and blue” with no strong dominance preference).

TypeScript

const results = await client.products.search({
  query: "patriotic t-shirt",
  filters: {
    colors: {
      palette: [{ hex: "#FF0000" }, { hex: "#FFFFFF" }, { hex: "#0000FF" }],
    },
  },
});

Getting Started

Make a Search

Get Product Data

Checkout

Pricing, Reporting, and Commissions

Build

Integrate

FAQ

Basic color filter

Multiple colors

Color percentages

​Basic color filter

​Multiple colors

​Color percentages

Basic color filter

Multiple colors

Color percentages