Skip to main content
POST
Add product video

Authorizations

X-API-Key
string
header
required

Path Parameters

organization_id
string<shortuuid>
required

UUID of the organization that owns the product.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
gtin
string
required

GTIN-8/12/13/14 of the target product. Normalized to GTIN-14 by zero-padding before lookup.

Pattern: ^\d{8,14}$

Body

application/json

Request body for adding a YouTube video link to a product.

youtube_url
string<uri>
required

YouTube video URL. Must be a watch / youtu.be / embed URL a video id can be parsed from.

Example:

"https://www.youtube.com/watch?v=dQw4w9WgXcQ"

title
string
default:""

Caption for the video. Empty string when not specified.

Maximum string length: 255
Example:

"Product overview"

description
string
default:""

Free-text description of the video. Empty string when not specified.

priority
integer
default:0

Display order within the product's video list. Lower numbers appear first; ties break on -created.

Required range: x >= 0

Response

201 - application/json

Created

A single YouTube video attached to a product.

id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
youtube_url
string<uri>
required

YouTube video URL as entered.

Example:

"https://www.youtube.com/watch?v=dQw4w9WgXcQ"

title
string
required

Caption for the video. Empty string when not set.

Maximum string length: 255
description
string
required

Free-text description of the video. Empty string when not set.

priority
integer
required

Display order within the product's video list. Lower numbers appear first.

Required range: x >= 0
created
string<date-time>
required

ISO-8601 UTC timestamp of when the video was added.

video_id
string | null

Parsed YouTube video id (e.g. dQw4w9WgXcQ). Null when the URL couldn't be parsed.

embed_url
string<uri>

YouTube embed URL derived from video_id. Null when the URL couldn't be parsed.

thumbnail_url
string<uri>

YouTube thumbnail URL derived from video_id. Null when the URL couldn't be parsed.