RetailLink
OverviewGetting startedA–Z indexAdmin overviewAdmin pagesAdmin settingsPOS overviewPOS screensStorefrontMerchant APIObjectsAuthenticationWebhooks

Object

Admin / POS

product_media

An image or media asset on a product.

Gallery items for a product (variant-specific images use VariantImage).

Exposure

Used in Admin, POS, or Storefront. Not exposed on Merchant API v1 routes yet.

What

The product_media object is the JSON / domain shape for this resource in RetailLink.

Why

Use these fields when integrating — not scraped Admin HTML — so sync jobs and apps stay stable across UI changes.

How

Read each property below — description first, then that property's Code / Data / Output (or type). Use the sticky example JSON on the right as a full fixture.

Properties

6 fields on product_media. Types link to related objects when available. Snippets for a property appear under that property.

id

string

Media id.

Type
id: string

url

string

Public or CDN URL of the asset.

Type
url: string

alt

string | null

Alt text for accessibility.

Type
alt: string | null

type

MediaType

Media kind (default IMAGE).

Type
type: IMAGE | VIDEO | MODEL_3D

position

number

Gallery sort order.

Type
position: number

createdAt

string

ISO-8601 created timestamp.

Type
createdAt: string

Related