Promotions
Active promotions (sales, bundles) with their labels and dates. Use promotions/{promotion}/products for the items on offer.
Authorization
http Use a Sanctum bearer token.
In: header
Query Parameters
length <= 100Value in
- "priority"
- "ending_soon"
- "newest"
- null
1 <= value <= 50Header Parameters
Your store API key (Dashboard → Settings → API keys). pk_live_… public keys are for browser code and only work from an origin on the key's allowlist; sk_live_… private keys are for servers and native apps and need no Origin.
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/store/promotions" \ -H "X-Client-Key: {{clientKey}}"{ "property1": null, "property2": null}Paginated products on one promotion.
Authorization
http Use a Sanctum bearer token.
In: header
Path Parameters
Query Parameters
length <= 100Value in
- "newest"
- "price_low"
- "price_high"
- "popular"
- null
1 <= value <= 501 <= valueHeader Parameters
Your store API key (Dashboard → Settings → API keys). pk_live_… public keys are for browser code and only work from an origin on the key's allowlist; sk_live_… private keys are for servers and native apps and need no Origin.
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/store/promotions/string/products" \ -H "X-Client-Key: {{clientKey}}"{ "property1": null, "property2": null}