Skip to content

Get reel collection​

GET
/rest/v1/cms/reel

Returns the merchant's active, promoted, fully transcoded and playable reels. Rows are scoped by a mandatory server-side invariant (active, is_promo, status = FINISHED, cdn_video_id present) that no query parameter can widen or relax. Default order is newest first (-createdAt), matching the homepage strip; pass sort=-updatedAt for the /reels page ordering. Each reel carries its localized name, resolved playback URLs and the ordered ids of the products it features. How many reels the homepage strip should show is published as videoShowcase.homepageLimit on GET /rest/storefront-config — pass it back as ?limit; it is advisory and not enforced here.

Parameters​

Query Parameters

filter[id]

Filter by reel IDs (comma-separated for several)

Type
string
sort

Sort order: createdAt or updatedAt, prefixed with - for descending. Defaults to -createdAt.

Type
string
page

Page number

Type
integer
limit

Pagination limit

Type
integer
with

With relations (translations; scopable as translations[el])

Type
string

Responses​

Successful operation

application/json
JSON
"string"

Playground​

Variables
Key
Value

Samples​

Powered by VitePress OpenAPI