Image
Get Image Comparables
- Documentation
- Blog
- Image
- Video
- Cart
- Checkout
API Reference
Image
Get Image Comparables
Retrieve products and similar products based on image media ID
GET
/
image
/
comparables
/
{id}
id
integer
*
id
Required
integer
Path Parameters
id
integer
requiredResponse
200 - application/json
image_info
object
image_info.id
integer
image_info.slug
string
A combination of platform + file name
image_info.platform
string
products
object[]
products.id
integer
products.external_id
string
The ID that exists in the order management system
products.title
string
products.brand
string
products.url
string
products.price
integer
products.currency
string
products.category
string
products.image
string
products.native_checkout
boolean
Whether or not this product has SKUs available for native checkout
products.variants
object[]
products.variants.name
string
products.variants.visual
boolean
products.variants.values
string[]
products.skus
object[]
products.skus.sku_id
integer
products.skus.product_id
integer
products.skus.external_id
string
The ID that exists in the order management system
products.skus.merchant_id
integer
products.skus.name
string
products.skus.in_stock
boolean
products.skus.qty_available
integer
products.skus.sale_price
number
products.skus.retail_price
number
products.skus.currency
string
products.skus.status
string
products.skus.type
string
products.skus.taxable
boolean
products.skus.tax_type
string
products.skus.variant_values
object[]
products.skus.variant_values.variant
string
products.skus.variant_values.value
string
products.skus.sku_dimensions
object
products.skus.sku_dimensions.weight
number
products.skus.sku_dimensions.type
string
products.similar_products
object[]
products.similar_products.id
integer
products.similar_products.external_id
string
The ID that exists in the order management system
products.similar_products.title
string
products.similar_products.brand
string
products.similar_products.url
string
products.similar_products.price
integer
products.similar_products.currency
string
products.similar_products.category
string
products.similar_products.image
string
products.similar_products.native_checkout
boolean
Whether or not this product has SKUs available for native checkout
products.similar_products.variants
object[]
products.similar_products.variants.name
string
products.similar_products.variants.visual
boolean
products.similar_products.variants.values
string[]
products.similar_products.skus
object[]
products.similar_products.skus.sku_id
integer
products.similar_products.skus.product_id
integer
products.similar_products.skus.external_id
string
The ID that exists in the order management system
products.similar_products.skus.merchant_id
integer
products.similar_products.skus.name
string
products.similar_products.skus.in_stock
boolean
products.similar_products.skus.qty_available
integer
products.similar_products.skus.sale_price
number
products.similar_products.skus.retail_price
number
products.similar_products.skus.currency
string
products.similar_products.skus.status
string
products.similar_products.skus.type
string
products.similar_products.skus.taxable
boolean
products.similar_products.skus.tax_type
string
products.similar_products.skus.variant_values
object[]
products.similar_products.skus.variant_values.variant
string
products.similar_products.skus.variant_values.value
string
products.similar_products.skus.sku_dimensions
object
products.similar_products.skus.sku_dimensions.weight
number
products.similar_products.skus.sku_dimensions.type
string
products.similar_products.price_tier
string
Can be "high", "medium", or "low"