CHchannel3-ai
v1

Similar Products

Changed on

Find products similar to a given product.

Results are pinned to the seed product's category. Consider setting filters to narrow further (gender, brand, price). Pass config.collection_id to keep neighbors inside a saved collection.

post/v1/similar

Request

  • Base URL
    https://api.trychannel3.com
  • URL
    https://api.trychannel3.com/v1/similar
  • 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

product_idstring required

Canonical product ID to find similar products for.

limitinteger nullable

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

page_tokenstring nullable

Opaque token from a previous similar response to fetch the next page of results.

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 //