Skip to main content
GET
/
api
/
v1
/
brands
/
domain
/
{domain}
JavaScript
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);
import os
from checkout_intents import CheckoutIntents

client = CheckoutIntents(
    api_key=os.environ.get("CHECKOUT_INTENTS_API_KEY"),  # This is the default and can be omitted
)
brand = client.brands.retrieve(
    "shop.aloyoga.com",
)
print(brand.id)
package com.rye.example;

import com.rye.client.CheckoutIntentsClient;
import com.rye.client.okhttp.CheckoutIntentsOkHttpClient;
import com.rye.models.brands.BrandRetrieveParams;
import com.rye.models.brands.BrandRetrieveResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        CheckoutIntentsClient client = CheckoutIntentsOkHttpClient.fromEnv();

        BrandRetrieveResponse brand = client.brands().retrieve("shop.aloyoga.com");
    }
}
curl https://staging.api.rye.com/api/v1/brands/domain/$DOMAIN \
    -H "Authorization: Bearer $CHECKOUT_INTENTS_API_KEY"
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://staging.api.rye.com/api/v1/brands/domain/{domain}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://staging.api.rye.com/api/v1/brands/domain/{domain}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
require 'uri'
require 'net/http'

url = URI("https://staging.api.rye.com/api/v1/brands/domain/{domain}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "supported": true,
  "id": "<string>"
}
{
  "name": "<string>",
  "message": "<string>",
  "stack": "<string>"
}
{
  "name": "<string>",
  "message": "<string>",
  "stack": "<string>"
}
{
  "name": "<string>",
  "message": "<string>",
  "status": 123,
  "fields": {},
  "stack": "<string>"
}
{
  "name": "<string>",
  "message": "<string>",
  "stack": "<string>"
}

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
id
string
required

A unique identifier for the brand.