Draft 0.2 – open for comment. Changes are expected.

Give feedback

Media

Images with defined roles, documents, videos and 3D/AR models in real-world scale.

Block: Media · Specification 0.2

The media module references images, documents, videos and 3D models by URL. Every file has a role, so that a shop can pick the main image, a marketplace the packshot and a configurator the 3D model – without guessing from file names.

Images

At least one image has the role hero: it identifies the product in listings. Online offers need information to identify the product, including a picture (GPSR Art. 19). Further roles cover packshots, lifestyle and detail images, the folded product, dimension drawings and the packaging. Every image SHOULD have a text alternative per language.

Documents

User manuals, assembly instructions, declarations of conformity, test reports, safety data sheets and spare-part lists are listed with their type and language. Each document entry has one language; add one entry per language version.

3D and augmented reality

3D models are referenced as binary glTF (GLB) and, for AR on Apple devices, as USDZ. Models are modelled in real-world scale with metres as unit, so that a stroller appears in its real size in a room. variantGtins connects a model to the variants it shows.

Media: fields 23 fields, generated from media.schema.json · in a record under media
Field Type Level Description Example
images Link to field images array of objects (min. 1) MUST

Product images. At least one image has the role hero: it identifies the product in listings.

images[]. url Link to field images[].url string (URL) MUST

URL of the image file.

https://example.com
images[]. role Link to field images[].role string MUST

Purpose of the image: hero (main image), packshot, lifestyle, detail, folded, dimension-drawing or packaging.

Values:
  • hero
  • packshot
  • lifestyle
  • detail
  • folded
  • dimension-drawing
  • packaging
hero
images[]. altText Link to field images[].altText localized string SHOULD

Text alternative that describes the image, per language.

images[]. variantGtin Link to field images[].variantGtin string (GTIN) MAY

GTIN of the variant shown, if the image shows a different variant than the record.

9521234567899
images[]. widthPx Link to field images[].widthPx integer MAY

Width of the image in pixels.

2000
images[]. heightPx Link to field images[].heightPx integer MAY

Height of the image in pixels.

2000
documents Link to field documents array of objects SHOULD

Documents for consumers and retailers, such as user manuals and declarations of conformity.

documents[]. type Link to field documents[].type string MUST

Kind of document.

Values:
  • user-manual
  • assembly-instructions
  • declaration-of-conformity
  • test-report
  • safety-data-sheet
  • spare-parts
user-manual
documents[]. url Link to field documents[].url string (URL) MUST

URL of the document file.

https://example.com
documents[]. language Link to field documents[].language string (language tag) MUST

Language of the document. Each entry has one language; add one entry per language version.

en
videos Link to field videos array of objects MAY

Product videos.

videos[]. url Link to field videos[].url string (URL) MUST

URL of the video file or page.

https://example.com
videos[]. role Link to field videos[].role string MUST

Purpose of the video.

Values:
  • overview
  • folding
  • assembly
  • installation
  • safety
  • other
folding
videos[]. language Link to field videos[].language string (language tag) MAY

Spoken or written language of the video, if any.

en
models3d Link to field models3d array of objects MAY

3D models for viewers and augmented reality, in real-world scale.

models3d[]. glbUrl Link to field models3d[].glbUrl string (URL) MUST

URL of the model as binary glTF (GLB).

https://example.com
models3d[]. usdzUrl Link to field models3d[].usdzUrl string (URL) SHOULD

URL of the model as USDZ, for AR on Apple devices.

https://example.com
models3d[]. realWorldScale Link to field models3d[].realWorldScale boolean MUST

Whether the model is modelled in real-world scale.

true
models3d[]. units Link to field models3d[].units string, always "m" MUST

Unit of the model coordinates. Always metres.

m
models3d[]. variantGtins Link to field models3d[].variantGtins array of GTINs (min. 1) SHOULD

GTINs of the variants the model represents.

models3d[]. polycount Link to field models3d[].polycount integer MAY

Number of polygons, to help consumers choose a suitable model.

85000
models3d[]. arReady Link to field models3d[].arReady boolean SHOULD

Whether the model is prepared for augmented reality viewers.

true