Products

const { products, pagination } = await client.products.listProducts({
  search: 'Sony',
  limit: 20,
  fields: 'name,price,stock,has_variants,product_slug,thumbnail_url'
});

// For subsequent pages, pass the cursor from the previous response:
// const next = await client.products.listProducts({ limit: 20, cursor: pagination.next_cursor });

console.log(`Has more: ${pagination.has_more}`);
if (pagination.next_cursor) {
  // Use pagination.next_cursor for the subsequent request
}

const personalized = new Tybrite({
  apiKey: 'tybrite_pk_live_...',
  headers: { 'x-auth-token': customerSessionToken },
});

const { products } = await personalized.products.listProducts({
  personalize: true,
  limit: 20,
  fields: 'name,price,thumbnail_url'
});
// → products re-ordered by how closely each matches this shopper; same row shape as above:
//   [ { name: "Sony WH-1000XM4", price: 349.99, thumbnail_url: "https://cdn.example.com/..." }, ... ]

const { products } = await client.products.listProducts({ brand: 'Samsung', limit: 20 });

const { brands, total } = await client.products.listBrands();

const product = await client.products.getProduct({
  id: '7d425c0a-50e7-4e39-af79-6f7945f9dfa8', // a multi-variant product (Sony WH-1000XM4)
  fields: 'name,thumbnail_url,media,price_range,total_stock,variants.sku,variants.media,variants.variant_attributes'
});

if (product.has_variants) {
  console.log(`Variants available: ${product.variant_count}`);
  console.log(`Price Range: ${product.price_range.min} - ${product.price_range.max}`);

  // Access variant-specific media (e.g., if user selects 'Grey' color)
  const greyVariant = product.variants.find(v => v.variant_attributes?.color === 'Grey');
  console.log(`Grey variation images: ${greyVariant?.media.length}`);
}

const product = await client.products.getProductBySlug({
  slug: 'sony-wh-1000xm4-a089d-7d425c0a',
  fields: 'seo_title,seo_description,thumbnail_url,media,price_range,variants.*'
});
// → identical structure to getProduct: root metadata + (for multi-variant products)
//   price_range, total_stock, and a variants[] array. See the getProduct response above.

const product = await client.products.getProductBySlug({ slug: 'sony-wh-1000xm4-a089d-7d425c0a' });
// → product.seo_title, product.seo_description, and product.seo_keywords (string[]) are present
//   when set, e.g. seo_title: "Nebula Ceramic Mug | 350ml Dishwasher Safe",
//   seo_keywords: ["ceramic mug", "stoneware mug", "coffee mug", "dishwasher safe mug"]
document.title = product.seo_title ?? product.name;
// <meta name="description" content={product.seo_description ?? product.description} />

fields=product_id,name,brand,thumbnail_url,total_stock,price_range,variants

# Get only the SKU and specific media for each variant
fields=name,variants.sku,variants.media,variants.variant_attributes

const { specification_data } = await client.products.getProductSpecifications({
  id: '9a47e047-b1b6-4c35-9617-820629e22e04' // a VARIANT UUID (not a product id)
});

// List all active collections
const { collections } = await client.products.listProductCollections({ 
  showOnHomepage: 'true',
  limit: 20
});
// → collections: [
//     { id: "45e28d12-9381-45f6-98bb-cb3a34c0a215", name: "Featured", slug: "featured",
//       description: "Hand-picked products to highlight on your storefront.",
//       collection_type: "featured_collections", is_active: true,
//       show_on_homepage: true, display_priority: 0,
//       image: "https://media.example.com/.../featured-desktop.jpg",
//       image_mobile: "https://media.example.com/.../featured-mobile.jpg" },
//     { id: "e9810818-5051-4b74-a53b-2ff843b4f435", name: "New Arrivals", slug: "new-arrivals",
//       collection_type: "new_arrivals", is_active: true, image: null, image_mobile: null, ... }
//   ]

// Get items in a specific collection (returns all items, ordered by sort_order)
// Each item has: product_id, sort_order, and an embedded product object
const { items } = await client.products.getProductCollectionItems({
  id: '45e28d12-9381-45f6-98bb-cb3a34c0a215' // e.g. the "Featured" collection
});
// → items: [
//     { product_id: "7d425c0a-50e7-4e39-af79-6f7945f9dfa8", sort_order: 0,
//       product: { id: "7d425c0a-50e7-4e39-af79-6f7945f9dfa8", name: "Sony WH-1000XM4",
//                  slug: "sony-wh-1000xm4-a089d-7d425c0a", brand: "Sony",
//                  has_variants: true, is_active: true } },
//     ...
//   ]
// (an empty collection returns { items: [] })

for (const item of items) {
  console.log(`${item.product.name} — sort order: ${item.sort_order}`);
}