RYrye-com
Brands

Retrieve brand

Changed on

Retrieve brand information by domain name

Look up a brand by its domain name (e.g. "aloyoga.com" or "www.amazon.com"). Returns brand information including the marketplace type if the lookup succeeds.

get/api/v1/brands/domain/{domain}

Request

  • Base URL
    https://staging.api.rye.com
  • URL
    https://staging.api.rye.com/api/v1/brands/domain/{domain}
  • Auth
    API key in header Authorization

Path parameters

domainstring hostname required

Represents a valid domain name string.

Example:shop.aloyoga.com

The domain name to look up (e.g. "aloyoga.com", "www.amazon.com")

Response

Brand information including marketplace classification

supportedboolean required

If false, then products from this brand cannot be purchased through the Sell Anything API.

marketplace'AMAZON' | 'SHOPIFY' | 'BESTBUY' | 'SEPHORA' | 'UNKNOWN' required
idstring required

A unique identifier for the brand.

Changes

  • 0b28c67737d3Revision changes
    • info

      the security scope checkout_intents:read was added to the endpoint's security scheme bearerAuth

  • dfc099f2ee48Revision changes
    • warning

      added the new SEPHORA enum value to the response property for the response status