Product Assets

Manage product images, documents, and media files in Omnium with automatic resizing and CDN delivery.

Product assets in Omnium provide a comprehensive system for managing images, documents, and other media files associated with products. Assets are stored securely with optional CDN delivery and support automatic preview image generation.


Key Concepts

What Are Product Assets?

Product assets are files attached to products, typically images but also documents, videos, or any file type. Each product can have multiple assets with rich metadata including:

  • Main image designation
  • Alt text for accessibility
  • Custom properties
  • Sort order
  • Purpose/category classification

Storage Architecture

Assets are stored using a multi-tier architecture:

LayerPurpose
MetadataAsset properties stored with products
FilesBinary file storage (managed by Omnium)
DeliveryCDN for fast global asset delivery (optional)

Asset Properties on Products

Products contain assets in two ways:

PropertyTypeDescription
MainImageUrlstringURL to the primary product image
AssetsList<Asset>Collection of all product assets

Feature Overview

Automatic Upload

External asset URLs are automatically downloaded and stored in Omnium during product import or update operations.

Preview Image Generation

When enabled, Omnium automatically generates resized preview images at configured aspect ratios (e.g., thumbnails, hero images, square crops).

CDN Integration

Asset URLs are automatically converted to CDN URLs when configured, ensuring fast global delivery.

Main Image Management

The IsMainImage flag and MainImageUrl property are automatically synchronized across products and variants.


Common Use Cases

E-commerce Product Images

  • Primary product photos
  • Alternate angle images
  • Zoom images
  • Lifestyle/contextual images

Documentation

  • Product manuals (PDF)
  • Specification sheets
  • Care instructions

Marketing Assets

  • Campaign images
  • Banner graphics
  • Social media assets

Documentation Sections

SectionDescription
ConfigurationImage processing settings
Asset ModelComplete property reference
Product AssetsWorking with assets on products
Asset UploadUpload operations and services
Preview ImagesAutomatic image resizing
API ReferenceAPI endpoints for assets

Quick Start

1. Add Assets to Products

Include assets when creating or updating products:

{
  "productId": "shirt-001",
  "mainImageUrl": "https://example.com/images/shirt-front.jpg",
  "assets": [
    {
      "externalUrl": "https://example.com/images/shirt-front.jpg",
      "isMainImage": true,
      "altText": "Blue cotton shirt - front view"
    },
    {
      "externalUrl": "https://example.com/images/shirt-back.jpg",
      "altText": "Blue cotton shirt - back view",
      "sortOrder": 2
    }
  ]
}

2. Assets Are Automatically Processed

Omnium will:

  1. Download external URLs to storage
  2. Generate preview images (if configured)
  3. Update asset URLs to internal/CDN URLs
  4. Index asset metadata with the product