Endpoint Details
POST
/api/v0/products/{id}/images
multipart/form-data
Idempotency: Supported (recommended for upload operations)
Parameters
Product ID to upload images for
Format: UUID v4
Example:
Format: UUID v4
Example:
"550e8400-e29b-41d4-a716-446655440000"
Form Data Fields
Image files to upload (multiple files supported)
Max files: 10 per request
Max size: 10MB per file
Max files: 10 per request
Max size: 10MB per file
Whether to replace all existing images
Default:
Example:
Default:
false
Example:
true
Starting position for new images (0-based)
Default: Append to end
Example:
Default: Append to end
Example:
2
Image Requirements
Supported Formats
- JPEG (.jpg, .jpeg)
- PNG (.png)
- WebP (.webp)
- GIF (.gif) - animations preserved
Size Specifications
- Maximum file size: 10MB per image
- Recommended dimensions: 1200x1200px or larger
- Minimum dimensions: 400x400px
- Aspect ratio: Square (1:1) recommended for best display
Quality Guidelines
- Resolution: High-resolution images for best quality
- Compression: Balanced compression for web optimization
- Background: Clean, professional backgrounds preferred
- Lighting: Even lighting with minimal shadows
Request Examples
Response Format
Success Response (200 OK)
Error Responses
Image Processing
Automatic Optimization
- Format Conversion: WebP generation for modern browsers
- Size Optimization: Multiple sizes for different use cases
- Quality Adjustment: Balanced compression for web delivery
- Thumbnail Generation: Small previews for listings
Generated Variants
- Original: Uploaded image (up to 10MB)
- Large: 1200px max dimension for product pages
- Medium: 600px max dimension for catalogs
- Small: 300px max dimension for thumbnails
- WebP: Modern format for supported browsers
CDN Distribution
- Global Delivery: Images served from edge locations
- Cache Headers: Optimized caching for fast loading
- SSL/HTTPS: Secure image delivery
- Responsive URLs: Different sizes for different devices
Best Practices
Image Organization
Performance Optimization
Quality Guidelines
- Resolution: Upload high-resolution originals (1200px+ recommended)
- Aspect Ratio: Square (1:1) or landscape (4:3) work best
- Background: Clean, neutral backgrounds for product shots
- Lighting: Even, natural lighting without harsh shadows
- Focus: Sharp focus on product details
- Context: Include lifestyle shots showing product in use
Advanced Features
Batch Processing
Image Management
Next Steps
After uploading product images, you can:- Update Product Details: Modify product information to reference new images
- Test Display: Verify images appear correctly in your application
- Optimize Loading: Implement lazy loading and responsive images
- Monitor Performance: Track image load times and conversion impact
- Manage Storage: Set up automated cleanup for unused images
For more information, see: