Image
Get Image By ID
- Documentation
- Blog
Image
Video
Cart
Checkout
API Reference
Image
Get Image By ID
Retrieves a single image media by ID
GET
/
image
/
{id}
id
integer
*
id
Required
integer
curl --request GET \
--url https://client-request-service-staging-wghsjlqnoa-uw.a.run.app/image/{id}
{
"image_info": {
"id": 123,
"slug": "<string>",
"platform": "<string>"
},
"products": [
{
"id": 123,
"external_id": "<string>",
"title": "<string>",
"brand": "<string>",
"url": "<string>",
"price": 123,
"currency": "<string>",
"category": "<string>",
"image": "<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>",
"variant_values": [
{
"variant": "<string>",
"value": "<string>"
}
],
"sku_dimensions": {
"weight": 123,
"type": "<string>"
}
}
]
}
]
}
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
curl --request GET \
--url https://client-request-service-staging-wghsjlqnoa-uw.a.run.app/image/{id}
{
"image_info": {
"id": 123,
"slug": "<string>",
"platform": "<string>"
},
"products": [
{
"id": 123,
"external_id": "<string>",
"title": "<string>",
"brand": "<string>",
"url": "<string>",
"price": 123,
"currency": "<string>",
"category": "<string>",
"image": "<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>",
"variant_values": [
{
"variant": "<string>",
"value": "<string>"
}
],
"sku_dimensions": {
"weight": 123,
"type": "<string>"
}
}
]
}
]
}