Image
Get Image Comparables By Slug
Image
Get Image Comparables By Slug
Get exact products and comparables for an image media by slug
GET
/
image
/
comparables
/
slug
/
{slug}
curl --request GET \
--url https://client-request-service-staging-wghsjlqnoa-uw.a.run.app/image/comparables/slug/{slug}
{
"image_info": {
"id": 123,
"slug": "<string>",
"file_name": "<string>",
"platform": "<string>"
},
"products": [
{
"id": 123,
"external_id": "<string>",
"title": "<string>",
"brand": "<string>",
"url": "<string>",
"price": 123,
"currency": "<string>",
"category": "<string>",
"is_available": true,
"images": [
"<string>"
],
"native_checkout": true,
"variants": [
{
"name": "<string>",
"visual": true,
"values": [
"<string>"
]
}
],
"skus": [
{
"sku_id": 123,
"product_id": 123,
"external_id": "<string>",
"merchant_id": 123,
"name": "<string>",
"in_stock": true,
"qty_available": 123,
"sale_price": 123,
"retail_price": 123,
"currency": "<string>",
"status": "<string>",
"type": "<string>",
"taxable": true,
"tax_type": "<string>",
"date_created": "<string>",
"date_last_modified": "<string>",
"variant_values": [
{
"variant": "<string>",
"value": "<string>"
}
],
"sku_dimensions": [
{
"weight": 123,
"type": "<string>"
}
]
}
],
"similar_products": [
{
"id": 123,
"external_id": "<string>",
"title": "<string>",
"brand": "<string>",
"url": "<string>",
"price": 123,
"currency": "<string>",
"category": "<string>",
"is_available": true,
"images": [
"<string>"
],
"native_checkout": true,
"variants": [
{
"name": "<string>",
"visual": true,
"values": [
"<string>"
]
}
],
"skus": [
{
"sku_id": 123,
"product_id": 123,
"external_id": "<string>",
"merchant_id": 123,
"name": "<string>",
"in_stock": true,
"qty_available": 123,
"sale_price": 123,
"retail_price": 123,
"currency": "<string>",
"status": "<string>",
"type": "<string>",
"taxable": true,
"tax_type": "<string>",
"date_created": "<string>",
"date_last_modified": "<string>",
"variant_values": [
{
"variant": "<string>",
"value": "<string>"
}
],
"sku_dimensions": [
{
"weight": 123,
"type": "<string>"
}
]
}
],
"price_tier": "<string>"
}
]
}
]
}
Path Parameters
Response
200
application/json
Successful response
The ID that exists in the order management system
Whether or not this product has SKUs available for native checkout
The ID that exists in the order management system
The ID that exists in the order management system
Whether or not this product has SKUs available for native checkout
The ID that exists in the order management system
Can be "high", "medium", or "low"
curl --request GET \
--url https://client-request-service-staging-wghsjlqnoa-uw.a.run.app/image/comparables/slug/{slug}
{
"image_info": {
"id": 123,
"slug": "<string>",
"file_name": "<string>",
"platform": "<string>"
},
"products": [
{
"id": 123,
"external_id": "<string>",
"title": "<string>",
"brand": "<string>",
"url": "<string>",
"price": 123,
"currency": "<string>",
"category": "<string>",
"is_available": true,
"images": [
"<string>"
],
"native_checkout": true,
"variants": [
{
"name": "<string>",
"visual": true,
"values": [
"<string>"
]
}
],
"skus": [
{
"sku_id": 123,
"product_id": 123,
"external_id": "<string>",
"merchant_id": 123,
"name": "<string>",
"in_stock": true,
"qty_available": 123,
"sale_price": 123,
"retail_price": 123,
"currency": "<string>",
"status": "<string>",
"type": "<string>",
"taxable": true,
"tax_type": "<string>",
"date_created": "<string>",
"date_last_modified": "<string>",
"variant_values": [
{
"variant": "<string>",
"value": "<string>"
}
],
"sku_dimensions": [
{
"weight": 123,
"type": "<string>"
}
]
}
],
"similar_products": [
{
"id": 123,
"external_id": "<string>",
"title": "<string>",
"brand": "<string>",
"url": "<string>",
"price": 123,
"currency": "<string>",
"category": "<string>",
"is_available": true,
"images": [
"<string>"
],
"native_checkout": true,
"variants": [
{
"name": "<string>",
"visual": true,
"values": [
"<string>"
]
}
],
"skus": [
{
"sku_id": 123,
"product_id": 123,
"external_id": "<string>",
"merchant_id": 123,
"name": "<string>",
"in_stock": true,
"qty_available": 123,
"sale_price": 123,
"retail_price": 123,
"currency": "<string>",
"status": "<string>",
"type": "<string>",
"taxable": true,
"tax_type": "<string>",
"date_created": "<string>",
"date_last_modified": "<string>",
"variant_values": [
{
"variant": "<string>",
"value": "<string>"
}
],
"sku_dimensions": [
{
"weight": 123,
"type": "<string>"
}
]
}
],
"price_tier": "<string>"
}
]
}
]
}