Retrieve brand

import CheckoutIntents from 'checkout-intents'; const client = new CheckoutIntents({ apiKey: process.env['CHECKOUT_INTENTS_API_KEY'], // This is the default and can be omitted }); const brand = await client.brands.retrieve('shop.aloyoga.com'); console.log(brand.id);

Authorizations

Authorization

string

header

required

Rye API key

Path Parameters

domain

string<hostname>

required

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

Pattern: ^(?=.{1,253}$)(?!\-)([a-zA-Z0-9\-]{1,63}(?<!\-)\.)+[a-zA-Z]{2,63}$

Example:

"shop.aloyoga.com"

Response

Brand information including marketplace classification

supported

boolean

required

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

marketplace

enum<string>

required

Indicates what ecommerce platform the brand uses.

Available options:

AMAZON,

SHOPIFY,

BESTBUY,

SEPHORA,

UNKNOWN

string

required

A unique identifier for the brand.