CHchannel3-ai
v1

Browse

Changed on

List and page through products for a set of filters.

Useful for a static, grid view of products for a brand, website, or category.

At least one of filters.brand_ids, filters.category_ids, or filters.website_ids must be provided, unless config.collection_id is set.

Pagination is capped at 5 pages per browse; next_page_token is null on the final page. Contact support@trychannel3.com for deeper paging.

post/v1/browse

Request

  • Base URL
    https://api.trychannel3.com
  • URL
    https://api.trychannel3.com/v1/browse
  • Auth
    API key in header x-api-key

Headers

x-user-idstring nullable

Optional user identifier to attribute clicks and sales to a user in your system. Channel3 appends it to buy URLs in the response.

Request body

limitinteger nullable

Optional limit on the number of results. Default is 20, max is 30.

page_tokenstring nullable

Opaque token from a previous browse response to fetch the next page. Browsing is limited to 5 pages; next_page_token is null on the final page.

Response

Successful Response

next_page_tokenstring nullable

Token to fetch the next page. Null when no more results.

Changes

  • 7aededb0a617Revision changes
    • info

      added the new optional request property /

  • f642382eaf91Revision changes
    • info

      added the new PL enum value to the request property //

    • info

      added the new PLN enum value to the request property //

    • info

      added the new pl enum value to the request property //