Manage rich media assets

Overview

Use the Rich Media Management API to create rich media assets, associate them with catalog items, and delink catalog item associations.

Rich media assets are submitted using the OMNI_RICH_MEDIA feed.

After submission, Walmart returns a feedId that can be used to monitor processing status.

Use cases

• Create product videos.
• Associate additional catalog items with an existing rich media asset.
• Delink rich media assets from catalog items.

This API does not currently support updating the metadata of an existing video asset, such as the video title, thumbnail image, or closed captions. To modify this information, submit a new video asset.

Reference guide

This guide explains how to create rich media assets, associate them with additional catalog items, and delink item associations using the Rich Media feed workflow.

For complete endpoint details, request fields, and response definitions, refer to the Rich Media API Reference.

Endpoint

POST /v3/feeds?feedType=OMNI_RICH_MEDIA

Create a video asset

Use a video payload when creating a video asset.

Request sample

{ "SupplierItemFeedHeader": { "subCategory": "video", "feedType": "OMNI_RICH_MEDIA", "locale": "en", "version": "2.0.20240524-16_47_14", "subset": "EXTERNAL" }, "SupplierItem": [ { "Orderable": { "productId": "06703211947310" }, "Visible": { "Video": { "richMediaVideoAssetUrl": "https://example.com/video.mp4", "richMediaVideoTitle": "Product Overview Video", "richMediaVideoThumbnailUrl": "https://example.com/thumbnail.png", "richMediaVideoCategory": "Product Overview", "richMediaClosedCaption": [ { "richMediaClosedCaptioningUrl": "https://example.com/captions.vtt", "richMediaCaptionLanguage": "English" } ] } } } ]
}

Modify your request

1. Set subCategory to video.
2. Provide the product ID (GTIN) using Orderable.productId.
3. Provide the external video URL using richMediaVideoAssetUrl.
4. Provide a display title using richMediaVideoTitle.
5. Set richMediaVideoCategory to Product Overview.
6. Optionally provide a thumbnail image URL using richMediaVideoThumbnailUrl.
7. Optionally provide closed caption information using richMediaClosedCaption.
8. Submit the feed and save the returned feedId.

Associate additional catalog items with an existing rich media asset

Use this workflow to associate additional catalog items with an existing rich media asset.

Request sample

{ "SupplierItemFeedHeader": { "subCategory": "video", "feedType": "OMNI_RICH_MEDIA", "locale": "en", "version": "2.0.20240524-16_47_14", "subset": "EXTERNAL" }, "SupplierItem": [ { "Orderable": { "productId": "06703211947310" }, "Visible": { "Video": { (Use the complete `richMediaAsset` object from the Get all assets API.) "richMediaVideoAssetUrl": "https://i5.walmartimages.com/video.mp4", (URL retrieved from the Get all assets API) "richMediaVideoTitle": "Product Overview Video", "richMediaVideoThumbnailUrl": "https://i5.walmartimages.com/thumbnail.png",(URL retrieved from the Get all assets API) "richMediaVideoCategory": "Product Overview", "richMediaClosedCaption": [ { "richMediaClosedCaptioningUrl": "https://i5.walmartimages.com/captions.vtt",(URL retrieved from the Get all assets API) "richMediaCaptionLanguage": "English" } ] } } } ]
}

Modify your request

1. Use the Get all assets API to locate the existing rich media asset.
2. Use one or more query parameters described in the Get all assets guide, such as richMediaType, linkedGtins, or richMediaTitle, to narrow the search results.
3. Retrieve the complete richMediaAsset object from the response.
4. Reuse the returned richMediaAsset object in your request payload.
5. Include the product ID (GTIN) for each additional catalog item that you want to associate with the rich media asset.
6. Submit the feed and save the returned feedId.

Delink an asset

Use mediaOperations with a value of Delink to remove the association between a rich media asset and a catalog item. Delinking removes the association between the catalog item and the rich media asset but does not delete the rich media asset.

If all catalog items are delinked from a rich media asset, the asset remains in the media library. Rich media assets can currently be deleted using Seller Center.

"mediaOperations": "Delink"

Request sample

{ "SupplierItemFeedHeader": { "subCategory": "video", "feedType": "OMNI_RICH_MEDIA", "locale": "en", "version": "2.0.20240524-16_47_14", "subset": "EXTERNAL" }, "SupplierItem": [ { "Orderable": { "productId": "06703211947310" }, "Visible": { "Video": { (Use the complete `richMediaAsset` object from the Get all assets API.) "mediaOperations": "Delink", "richMediaVideoAssetUrl": "https://i5.walmartimages.com/video.mp4",(URL retrieved from the Get all assets API) "richMediaVideoTitle": "Product Overview Video", "richMediaVideoCategory": "Product Overview" } } } ]
}

Modify your request

1. Use the Get all assets API to locate the existing rich media asset.
2. Use one or more query parameters described in the Get all assets guide, such as richMediaType, linkedGtins, or richMediaTitle, to narrow the search results.
3. Retrieve the complete richMediaAsset object from the response.
4. Reuse the returned richMediaAsset object in your request.
5. Set mediaOperations to Delink.
6. Include only the product IDs (GTINs) that you want to delink. Catalog items that are not included remain associated with the rich media asset.
7. Submit the feed and save the returned feedId.
8. Monitor the feed processing to verify that the GTIN is no longer associated with the rich media asset.

Response sample

{ "feedId": "18B507B0440B59E29934D51ED3714B2A@AZEBBgA"
}

Results

After a successful request, Walmart returns a feedId and begins processing the rich media feed. Depending on the number of assets being processed, feed processing may take up to four hours.

Use the feedId to monitor processing status and review any item-level ingestion errors. After successful processing, the requested rich media asset changes are applied.

If the associated catalog item fails validation, the rich media asset is rejected and is not added to the asset library.

Common validation issues

For example, if the media file cannot be downloaded from the supplied URL, Walmart returns an item-level ingestion error indicating that the video file is not present at the provided location.

Next steps

• Get all assets
• Monitor feed processing
• Rich media management