CHchannel3-ai
v1

Lookup Product

Changed on

Retrieve product information for any product URL.

Returns the same Product model as GET /v1/products/{product_id}. The product_id in the response can be used with the Product Detail endpoint. Products from merchants outside the Channel3 catalog resolve for display purposes, but are not available to other endpoints (e.g. /v1/similar, price tracking).

post/v1/lookup

Request

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

urlstring required

The URL of the product to look up

max_staleness_hoursinteger

Maximum age (in hours) of cached product data before forcing a fresh lookup. Defaults to 3 hours.

realtime_fetchboolean

Fetch the product page live when the URL is not in the Channel3 catalog or its data is older than max_staleness_hours. When false, only catalog products are returned: stale data is returned as-is, and URLs not in the catalog return 404.

Response

Successful Response

Changes

  • 1ae48413f6a7Revision changes
    • info

      added the new optional request property

  • 93329818bdf4Revision changes
    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      added the new optional header request parameter x-user-id

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added to the /// response property anyOf list for the response status

    • info

      added to the / response property anyOf list for the response status

    • info

      added to the /////// response property anyOf list for the response status

    • info

      removed from the /////// response property anyOf list for the response status

    • info

      removed subschema #1 from the / response property anyOf list for the response status

    • info

      removed subschema #1 from the /// response property anyOf list for the response status