Skip to content

Promo Ads Management ​

The Promo Ads API provides endpoints to create, publish, update, and display promotional banners and call-to-action cards across your storefront and landing pages.

Endpoints ​

EndpointMethodPathDescription
Fetch Promo AdsGET/v1/promo-adsList store promo ads with cursor pagination
Fetch Published Promo AdsGET/v1/promo-ads/publishedPublic list of active published banners
Get Promo Ad DetailsGET/v1/promo-ads/{id} & /by-slug/{slug}View banner details by ID or slug
Add Promo AdPOST/v1/promo-adsCreate a new promotional banner
Update Promo AdPATCH/v1/promo-ads/{id}Update ad content, images, and CTA
Update Ad StatusPATCH/v1/promo-ads/update/{id}/status/{status}Publish or unpublish an ad
Delete Promo AdDELETE/v1/promo-ads/{id}Remove a promo ad

Build with joy