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

Media

The Media object enables vendors to add, view, or delete media from the product object.

This object contains the following attributes:

Field
Type
Description

id

string

(Read-only) The identifier for the media.

name

string

The name of the media.

description

string

A description of the media.

type

string

The type of the media.

url

string

The URI to access the media.

displayOrder

integer

The object's order in the list.

status

string

The status of the media.

product

object

Represents the product object.

audit

object

Represents the audit object.

Example

MEDIA OBJECT
  {
    "id": "MED-1234-1234",   
    "name": "Office 365 Product Image",
    "description": "An image of Office 365, which is available to purchase within the Microsoft 365 Online Services product",
    "type": "Image",
    "url": "https://address.to.media.file.pl/abcde.png",
    "displayOrder": 100,
    "state": "Draft",
    "product": {
      "id": "PRD-1111-1111-1111",   
      "name": "Microsoft Office 365 NCE",
      "icon": "/static/PRD-1111-1111-1111/logo.png"
     },
    "audit": {
     "created": { "at": "...", "by": { } },
     "updated": { "at": "...", "by": { } }
   }
  }

Last updated

Was this helpful?