campaigns
Open the interactive API reference (Swagger) ↗ — full request/response schemas and a try-it console.
/campaigns/storeList store campaigns
List campaigns for the authenticated client's shop, newest first. Returns campaign details only; fetch a single campaign to get its products.
/campaigns/store/{campaign_id}Get a store campaign
Return a single campaign of the authenticated client's shop, including its products with variants and stock levels. Stock is null for products that do not track stock.
/campaigns/store/{campaign_id}/create-linkCreate magic link
Create a reusable magic link for a campaign of the authenticated client's shop. The returned link opens the recipient storefront where an order can be placed.
/campaigns/store/{campaign_id}/deactivate-linkDeactivate magic link
Deactivate (revoke) a magic link of the authenticated client's shop so it can no longer be used to place orders. Idempotent: an already-deactivated link returns 200. A link that has already been used cannot be deactivated.
/campaigns/store/{campaign_id}/sales-summaryCampaign sales summary
Return sales totals for a campaign of the authenticated client's shop, plus a paginated per-order breakdown, newest first. Product cost covers item prices and branding fees; service and delivery fees are excluded. Cancelled orders are not counted. Totals always cover all orders of the campaign regardless of the requested page.