Skip to main content
Search query returns a grid of product results search_catalog returns real products from the merchant you name, with prices in integer minor units of the merchant’s currency (cents for USD, pence for GBP).

Search sources

Omit source to use the default (oxylabs). When oxylabs is chosen and Channel3 answers first with matching titles, the response arrives faster with source: "catalog".

Results

Each search returns up to 10 products:
price is integer minor units of currency. 1697 means $16.97 in USD, or £16.97 in GBP. availability is "in_stock", "out_of_stock", or null when unknown.

Relevance

Oxylabs and catalog results include a relevance field: "ok" or "low". When relevance is low, the response includes a hint explaining why. Always check titles before using a result — a search for “AA batteries” may return phone chargers when relevance is low.

Caching

Repeating the same oxylabs or catalog query within 15 minutes returns the cached result. The response includes cached_at with the original search time. Merchant search is never cached.

Reading a product page

get_product reads one product page by URL. It returns the same fields as search, plus reviews when the page has them:

Variants

When a product has selectable options (size, colour, pack count), the response includes options and variants. options lists the axes:
variants lists every combination:
The variant matching the original URL has featured: true. Use the variant id in update_cart line_items[].item.id and its url in line_items[].item.url.

Batch lookup

lookup_catalog reads up to 10 product pages in one call. Pass ids as an array of search id values or product URLs. A plain item id reads that merchant’s product page (on Walmart, "123456789" reads https://www.walmart.com/ip/123456789). Returns products (the ones that loaded) and failed ({ id, error } for each page that did not). One bad page does not fail the call.

Daily search cap

Each API key has a daily search allowance, resetting at UTC midnight. When the cap is hit, search_catalog returns daily_limit_reached with used_today and daily_cap. Non-search tools do not consume the allowance. Failed searches with auth or rate errors are not counted. See Rate limits for details.