API ReferenceHighlights

Overview

Manage ordered storefront highlight stories and their media.

Highlights are image or video promotions. They can link to an active, discoverable product in the same store. Creating one publishes it immediately; deleting its last media item unpublishes it and clears its sort order.

Use the highlight ability. Reorder requests are complete replacements: send every currently ordered ID exactly once. Media uploads accept previewable images or videos up to 30 MB, with one to 30 files on creation. The operation schemas define publication metadata and media response fields.

Endpoints

On this page