For the complete documentation index, see llms.txt. This page is also available as Markdown.

Special Images

Administrative endpoints for special images — the association that flags one of a product's images as serving a specific purpose (base, swatch, listing, or picto). A special image points at an existing product image and marks the role that image plays; it does not upload or store the image itself.

Core Capabilities

1. Special Image Listing & Filtering

  • Retrieve a paginated list of special images.

  • Filter by image type and by the underlying product image.

2. Special Image Lifecycle Management

  • Assign an image role to a product (create), replacing any image previously holding that role for the same product.

  • Retrieve, replace (PUT), partially update (PATCH), or delete a single special image.

Image Types

The image_type field selects the role the image plays. Each (product, image_type) pair is unique: a product can hold at most one image of each type.

Value
Description

base

The product's primary/base image.

swatch

A color or material swatch image.

listing

The image used in product listings.

picto

A pictogram / icon image.

Because the type is unique per product, creating or updating a special image is effectively an upsert: any existing record with the same product and image_type is removed first, so a new assignment always replaces the previous one and no duplicate or orphan row is left behind.

Dynamic Settings & Environment Variables

No dynamic settings (dj_dynamic_settings) and no environment variables affect these endpoints. Listing, creation, update, and deletion behave identically regardless of management-panel configuration.

Last updated

Was this helpful?