Media
The Media object enables vendors to add, view, or delete media from the product object. This object contains the following properties:
id
string
The identifier for the Media object.
name
string
The name of the Media object.
Example: Office 365 Product Image
description
string
A description of the Media object.
Example: An image of Office 365, available to purchase within the Microsoft 365 Online Services product.
type
string
The type of the Media object.
url
string
The URI to access the media object.
Example: https://address.to.media.file.pl/abcde.png
displayOrder
integer
The object's order in the list.
Example: 100
status
string
The status of the media.
Example: Published.
product
A reference to the Product object.
Example:
{
"id": "PRD-1111-1111-1111",
"name": "Microsoft Office 365 NCE",
"icon": "/static/PRD-1111-1111-1111/logo.png"
}
audit
A reference to the Audit object.
Example:
{
"created": { "at": "...", "by": { } },
"updated": { "at": "...", "by": { } }
}
Example
{
"id": "MED-1234-1234",
"href": "v1/catalog-management/media/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?