Skip to main content
GET
/
api
/
v1
/
products
/
lookup
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 product = await client.products.lookup({ url: 'url' });

console.log(product.id);
{
  "isPurchasable": true,
  "availability": "in_stock",
  "price": {
    "currencyCode": "USD",
    "amountSubunits": 1500
  },
  "images": [
    {
      "isFeatured": true,
      "url": "https://example.com/images/product-123.jpg"
    }
  ],
  "description": "A high-quality widget designed for professionals.",
  "brand": "Acme",
  "name": "Widget Pro",
  "sku": "SKU-12345",
  "retailer": "Amazon",
  "url": "https://example.com/products/widget-pro",
  "id": "amazon.com:B0DFC9MT8Q",
  "variants": [
    {
      "availability": "in_stock",
      "images": [
        {
          "isFeatured": true,
          "url": "https://example.com/images/product-123.jpg"
        }
      ],
      "price": {
        "currencyCode": "USD",
        "amountSubunits": 1500
      },
      "dimensions": [
        {
          "value": "Small, Red, XS, L, etc.",
          "label": "Size, Color, etc."
        }
      ],
      "name": "<string>",
      "sku": "<string>",
      "id": "<string>"
    }
  ],
  "variantDimensions": [
    {
      "values": [
        "<string>"
      ],
      "label": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs-test.rye.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Rye API key

Query Parameters

url
string
required

Response

Product information

isPurchasable
boolean
required
Example:

true

availability
enum<string>
required

The availability status of a product.

  • in_stock: Product is available for immediate purchase
  • out_of_stock: Product is currently unavailable
  • preorder: Product is available for pre-order before release
  • backorder: Product is temporarily out of stock but can be ordered
  • unknown: Availability could not be determined
Available options:
in_stock,
out_of_stock,
preorder,
backorder,
unknown
Example:

"in_stock"

price
object
required
images
object[]
required
description
string | null
required
Example:

"A high-quality widget designed for professionals."

brand
string | null
required
Example:

"Acme"

name
string
required
Example:

"Widget Pro"

sku
string | null
required
Example:

"SKU-12345"

retailer
string | null
required
Example:

"Amazon"

url
string
required
Example:

"https://example.com/products/widget-pro"

id
string
required
Example:

"amazon.com:B0DFC9MT8Q"

variants
object[] | null
variantDimensions
object[] | null