Overview
Create and manage storefront highlights, their media, publication state, and display order.
Highlights—called stories in parts of the dashboard—are ordered storefront promotions made from images or videos. A highlight can optionally hide itself from normal storefront placement, and each media item can link to an active, discoverable product in the same store.
Creating a highlight publishes it immediately. Deleting its last media item unpublishes it and clears its sort order. Add media and update the highlight with published: true to make it visible again.
Use an API key with the highlight ability. Highlight and media reorder requests are complete replacements: send every currently ordered ID exactly once.
Endpoints
The highlight model
- Name
idinteger- Description
- The highlight ID.
- Name
titlestring- Description
- The storefront title.
- Name
hiddenboolean- Description
- Whether normal storefront placement is hidden.
- Name
sort_orderinteger | null- Description
- The published display position, or
nullwhile unpublished. - Name
published_attimestamp | null- Description
- When the highlight was published.
- Name
mediaarray- Description
- Ordered images and videos attached to the highlight.
Media uploads accept previewable images or videos up to 30 MB. Create requests accept between one and 30 files using multipart form data.