zinn-campaigns

POST /v1/store-connect/orders/{ref}/updates

The store plugin sends one order's shopper an update from an approved template.

All zinn-campaigns endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

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/orders/{ref}/updates \
  -H "Content-Type: application/json" \
  -d '{ "kind": <string<order_received, payment_confirmed, on_hold, shipped, completed, ready_for_pickup, payment_failed, cancelled, refunded>>, "request_id": <string> }'

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. Feeds the plugin's zinn-ou/send-order-update ability (docs/1297 §22.3, edit_shop_orders in WordPress). kind is one of the approved, translated templates (never free text); the text goes to the order's own shopper, in their language, from the order's last event (a phone number is never taken from the request). The update is a new event sent by the same durable workflow as ingestStoreEvents, so every Campaigns guard applies: the shopper's order-updates consent, the line and channel switches, good standing, the STOP opt-out, the spike pause, the own sender and prepaid credit. Its outcome is read back with getStoreOrderMessages. request_id is the idempotency key for the order, whatever the kind: a repeat (even with another kind) books nothing and answers the FIRST update with duplicate: true. 403 when the account is on hold (nothing is booked), 404 when the engine has no event for the order, 429 after five staff-sent updates to one order in a day, 503 when the workflow service is down (the booking is kept; a retry with the same request_id starts it).

Parameters

NameTypeRequiredWhat it is
ref (path)stringYesThe store's order id.

Request body

NameTypeRequiredWhat it is
kindstring<order_received, payment_confirmed, on_hold, shipped, completed, ready_for_pickup, payment_failed, cancelled, refunded>Yes—
request_idstringYesIdempotency key per order, across every kind: a reused id returns the first update and books nothing.
tracking_urlstringNoAn absolute https URL whose host is a public DNS name (not percent-encoded, not an IP literal, loopback or bare name; punycode allowed), a numeric port 1-65535 if any, no…

Response

NameTypeRequiredWhat it is
idstringYes—
kindstringYes—
outcomestring<pending, processing, sent, skipped, failed>Yes—
duplicatebooleanYesThe request_id was seen before; nothing new was booked.

Errors this endpoint can return

401 · 403 · 404 · 422 · 429 · 503