Skip to main content
product_id
string
required
target_type
enum<string>
required
Available options:
product,
visual_group,
variant
variant_id
string | null
required
rank
integer
required
Required range: x >= 1
available
boolean | null
required

Known-unavailable targets are omitted; null means inventory is unknown.

score
number
title
string
handle
string
canonical_url
string<uri>
image_url
string<uri>
variant_title
string
price
string

Decimal amount.

compare_at_price
string

Decimal amount.

currency
string
fit_evidence
object