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

Product Videos

Administrative endpoints for product videos — video files attached to a product and shown alongside its images on the storefront.

Core Capabilities

1. Product Video Listing & Filtering

  • Retrieve a paginated list of product videos, ordered by order ascending by default.

  • Filter by product and by the stored video file reference.

2. Product Video Lifecycle Management

  • Attach a video to a product, supplying either inline video content or the storage path of an already-uploaded file.

  • Retrieve, update (PUT/PATCH), or delete a single product video.

Supplying the Video

A product video is defined by exactly one of two mutually complementary inputs — at least one must be provided on create:

Field
Description

video

Inline video file content sent as a string. It is wrapped into a file and stored.

video_path

The storage path of a video file that has already been uploaded to the media backend. The record simply points at that path.

When updating, the product and inline video fields cannot be changed; only video_path (to repoint the file), order, and other writable fields are applied.

Dynamic Settings & Environment Variables

No dynamic settings (dj_dynamic_settings) and no environment variables affect these endpoints.

Last updated

Was this helpful?