Installation
Authentication
You can provide your API key using theCHANNEL3_API_KEY environment variable, or by passing it directly to the client.
Default locale
Set a default locale once on the client and it’ll apply to every search and product detail call. Per-call values (e.g.config.country on search, ?country= on product detail) override the client default.
CHANNEL3_LANGUAGE, CHANNEL3_COUNTRY, CHANNEL3_CURRENCY. The same pattern applies to dimension units — set lengthUnit / weightUnit on the client (or CHANNEL3_LENGTH_UNIT / CHANNEL3_WEIGHT_UNIT) to choose the units dimensions come back in. See Dimension units.
When only
country is set, the server infers currency (e.g. GB → GBP) and language (e.g. GB → en). When all three are unset, defaults to en / US / USD.Usage
All top-level endpoints are available as properties on the client. For example, to use thesearch endpoint:
Async usage
Advanced SDK usage
Filters, pagination, image search, product detail, brands, categories, and error handling.