Skip to main content
GET
JavaScript

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