CHchannel3-ai
channel3-api

Websites

Changed on

Resolve a website URL to its ID and best_commission_rate.

Deprecated: GET /v1/websites/{website_id} accepts the same domains alongside website ids and returns the same fields, and GET /v1/websites/search finds a website by retailer name.

get/v0/websites

Request

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

Query parameters

querystring required
country'US' | 'GB' | 'EU' | 'AU' | 'CA' | 'IE' | 'DE' | 'AT' | 'FR' | 'BE' | 'IT' | 'ES' | 'NL' | 'SE' | 'FI' | 'PT' | 'CZ' | 'GR' | 'RO' | 'CH' | 'PL'

ISO 3166-1 alpha-2 country code (plus the pan-region EU).

ISO 3166-1 alpha-2 country code that best_commission_rate is scoped to. Defaults to 'US' when unset.

Response

Successful Response

idstring required
namestring nullable
urlstring required
logo_urlstring nullable
descriptionstring nullable
best_commission_ratenumber

The maximum commission rate for the website in the requested country (default 'US'), as a percentage

countriesCountryCode[]

Countries where this website has offers indexed in the catalog. Pass one in the X-Channel3-Country header to get this website's products there. Empty when the website has no products indexed yet.

Changes

  • fbe04bdb7b70Revision changes
    • info

      added the optional property / to the response with the status

  • f642382eaf91Revision changes
    • info

      added the enum value PL to the property anyOf[subschema #1: CountryCode]/ of the query request parameter country