Skip to main content

​
Overview

The Product Images API allows you to manage images associated with furniture products. Each product can have multiple images with configurable display order and alternative text for accessibility.

​
Base URL

All Product Images endpoints are available under: 
/api/v1/product-images

​
Product Image Object

The product image resource contains the following fields:
​
id
integer
required
Unique identifier for the product image
​
productId
integer
required
ID of the product this image belongs to
​
imageUrl
string
required
URL of the product image
​
altText
string
Alternative text description for accessibility
​
displayOrder
integer
Order in which the image should be displayed (lower numbers appear first)

​
Available Operations

List Product Images

Retrieve all product images or filter by product

Get Product Image

Retrieve a specific product image by ID

Create Product Image

Add a new image to a product

Update Product Image

Modify an existing product image

Delete Product Image

Remove a product image

​
Common Use Cases

​
Get All Images for a Product

Retrieve all images associated with a specific product: 
curl -X GET "https://api.example.com/api/v1/product-images/product/123"

​
Get Ordered Images

Retrieve images sorted by display order: 
curl -X GET "https://api.example.com/api/v1/product-images/product/123/ordered"

​
Get Primary Image

Retrieve the primary image for a product: 
curl -X GET "https://api.example.com/api/v1/product-images/product/123/primary"

​
Delete All Product Images

Remove all images for a specific product: 
curl -X DELETE "https://api.example.com/api/v1/product-images/product/123"

​
Best Practices

  • Display Order: Use consistent increments (e.g., 1, 2, 3) for display order to make reordering easier
  • Alt Text: Always provide descriptive alt text for accessibility compliance
  • Image URLs: Ensure URLs are accessible and point to optimized images
  • Primary Images: Designate one image as primary for product listings and previews

Build docs developers (and LLMs) love

Get started for freeTalk to us