Base URL
/api/v1/.
Launch resources
The v1 launch surface includes:- Profiles
- Templates
- Catalog Products
- Assets
- Brand Kit
- EmailSends
- Events
/api/v1/public/*, and the WriteKey-authenticated Ingest API are not part of this launch reference. For product-level guidance across those surfaces, see Which API should I use?.
Authentication
Send your API key in thex-api-key header:
Emails
The API reference includesPOST /api/v1/emails, POST /api/v1/emails/batch, and GET /api/v1/emails/{id}. For end-to-end examples and lifecycle guidance, read Emails.
Events
The API reference includesPOST /api/v1/events. For examples and Journey-triggering guidance, read Events.
Orders and products from other platforms
The API reference includesPOST /api/v1/events/order-transactions and its /batch variant for orders and refunds with their products, and the /api/v1/catalog-products/by-external-id/{externalId}, /batch, /batch-archive and /unmatched-order-items endpoints for products keyed by your own product IDs. To connect a Shopware, Salla or other store’s webhooks to them, directly or through n8n or Make, read Connect another store platform.
