> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trychannel3.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Usage

Commands follow a resource-based structure:

```sh theme={"theme":{"light":"github-light","dark":"github-dark"}}
channel3 [resource] <command> [flags...]
```

Pass `--help` on any command for full flags. Price and buy links live on `offers[]` — see [Offer](/guides/offer).

## Search

```sh theme={"theme":{"light":"github-light","dark":"github-dark"}}
channel3 products search --query-param "organic cotton t-shirt"
```

Limit results:

```sh theme={"theme":{"light":"github-light","dark":"github-dark"}}
channel3 products search --query-param "running shoes" --limit 5
```

## Filters

Pass filters as JSON, or nest fields with `--filters.<name>`:

```sh theme={"theme":{"light":"github-light","dark":"github-dark"}}
channel3 products search \
  --query-param "running shoes" \
  --filters '{
    "price": { "min_price": 50, "max_price": 150 },
    "availability": ["InStock"],
    "gender": "male"
  }'
```

```sh theme={"theme":{"light":"github-light","dark":"github-dark"}}
channel3 products search \
  --query-param "sweater" \
  --filters.price '{"min_price":50,"max_price":200}' \
  --filters.availability '["InStock"]'
```

Brand or website filters need IDs (or use domains for websites — see [website search](/guides/website-search)):

```sh theme={"theme":{"light":"github-light","dark":"github-dark"}}
# Resolve a brand first
channel3 brands search --query-param "nike"

# Then filter products
channel3 products search \
  --query-param "running shoes" \
  --filters.brand_ids '["brand_id_here"]'
```

## Image search

From a public URL:

```sh theme={"theme":{"light":"github-light","dark":"github-dark"}}
channel3 products search-by-image \
  --image-url "https://example.com/shoe.jpg"
```

From a local file (`@` sends the file; binary is base64-encoded automatically):

```sh theme={"theme":{"light":"github-light","dark":"github-dark"}}
channel3 products search-by-image --base64-image "$(base64 -i shoe.jpg)"
```

You can also pass `--image-url` or `--base64-image` on `products search` alongside `--query`.

## Lookup a store URL

```sh theme={"theme":{"light":"github-light","dark":"github-dark"}}
channel3 products lookup \
  --url "https://www.nike.com/t/air-force-1-07-mens-shoes-5QFp5Z/CW2288-111"
```

Returns the canonical product with every merchant offer.

## Product detail and similar

```sh theme={"theme":{"light":"github-light","dark":"github-dark"}}
channel3 products retrieve --product-id 2yh8WH5
```

```sh theme={"theme":{"light":"github-light","dark":"github-dark"}}
channel3 products find-similar --product-id 2yh8WH5 --limit 10
```

## Brands, categories, websites

```sh theme={"theme":{"light":"github-light","dark":"github-dark"}}
channel3 brands search --query-param "nike"
channel3 brands find --query-param "Nike"
channel3 brands list --limit 20
```

```sh theme={"theme":{"light":"github-light","dark":"github-dark"}}
channel3 categories search --query-param "sofas"
channel3 categories retrieve --slug sofas
```

```sh theme={"theme":{"light":"github-light","dark":"github-dark"}}
channel3 websites retrieve --query-param "https://www.bestbuy.com"
```

## Locale

Set defaults via env (`CHANNEL3_COUNTRY`, etc.) or per call:

```sh theme={"theme":{"light":"github-light","dark":"github-dark"}}
channel3 products search \
  --query-param "trainers" \
  --config.country=GB \
  --config.language=en \
  --config.currency=GBP
```

## Output formats

```sh theme={"theme":{"light":"github-light","dark":"github-dark"}}
# Table output (good default for humans)
channel3 products search --query-param "lamp" --format table

# Titles only (JMESPath)
channel3 products search \
  --query-param "running shoes" \
  --query "products[].title"

# First product's first offer price
channel3 products search \
  --query-param "merino sweater" \
  --limit 1 \
  --query "products[0].offers[0].price"

# Domains + prices for comparison
channel3 products search \
  --query-param "dyson vacuum" \
  --limit 1 \
  --query "products[0].offers[].{domain: domain, price: price.price}"
```

`--format` accepts `json`, `table`, `yaml`, `csv`, `jsonl`, `raw`, and `http`. `--query` uses [JMESPath](https://jmespath.org) — note it is the projection flag, while the search term is `--query-param`. See [Format output](/cli/output).

## Files

Prefix a path with `@` to send a file as an argument:

```sh theme={"theme":{"light":"github-light","dark":"github-dark"}}
channel3 products search-by-image --base64-image "$(base64 -i shoe.jpg)"
```

Escape a literal `@` with `\@` if you need the character in a string.

## Full reference

| Resource | Common commands |
| - | - |
| `products` | `search`, `search-by-image`, `lookup`, `retrieve`, `find-similar` |
| `brands` | `search`, `find`, `list`, `retrieve` |
| `categories` | `search`, `list`, `retrieve` |
| `websites` | `retrieve` |
| `price-tracking` | see `--help` |

```sh theme={"theme":{"light":"github-light","dark":"github-dark"}}
channel3 --help
channel3 products --help
```

API shapes: [What you request](/guides/request-overview) · [API reference](/api-reference/v1/search)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.