zinn-campaigns
POST /v1/store-connect/events
The store plugin posts order events; each new one sends the shopper an update in their language.
Authentication
This endpoint is public. It takes no credential and no organisation — it is what our own marketing site and AI answer engines read.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/store-connect/events \
-H "Content-Type: application/json" \
-d '{ "events": <StoreEventInput[]> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Store token only (Authorization: Bearer zou_…). A batch of 1-100 events (docs/1297 §4.4). id is the plugin's idempotency key (<site_uuid>:<integration>:<order>:<kind>:<seq>): a known key inserts nothing and never sends twice (duplicates). Each new event starts one durable send that picks the language (the shopper's locale, then the store's first language, then English), checks the shopper's order-updates consent and every Campaigns guard (line and channel switches, good standing, STOP opt-out, spike pause, own sender, prepaid credit), and records its outcome on the event. A kind with no template is stored and skipped. 503 when the workflow service is down: the rows are kept and a retry of the same batch starts them. Zinn® Campaigns flows (docs/1052 §11.9a): cart_abandoned, product_viewed and payment_confirmed enrol the org's active flows of trigger cart_abandoned, product_viewed and post_purchase when marketing_consent was ticked for e-mail at or before occurred_at (or the contact already holds an e-mail consent by then); cart_recovered ends an open cart flow; order_placed and payment_confirmed end open cart and browse flows. The shopper's customer.email finds the contact and is not kept on the event. A suppressed or unsubscribed shopper is never enrolled.
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
events | StoreEventInput[] | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
accepted | integer | Yes | Events being sent now. |
duplicates | integer | Yes | Events already handled (never sent twice). |
Errors this endpoint can return
401 · 422 · 429 · 503