zinn-campaigns
GET /v1/store-connect/orders/{ref}/messages
The store plugin reads one order's update history (sent, not sent and why, failed).
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 GET https://api.zinndigital.com/v1/store-connect/orders/{ref}/messagesSigned 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/get-order-messages ability (docs/1297 §22.3, edit_shop_orders in WordPress). Every update the engine handled for this ONE order of the token's ONE store, newest first, at most 50: another store's events, even of the same organisation and with the same order ref, are never returned. reason is the refusal code of an update not sent (noConsent, accountOnHold, …) or the failure class of one that failed (provider_outage when the messaging vendor was at fault, our_fault when we were, permanent, …). The shopper's number is masked to its last three digits. templates lists the approved kinds sendStoreOrderUpdate takes.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
ref (path) | string | Yes | The store's order id. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
ref | string | Yes | — |
templates | string<order_received, payment_confirmed, on_hold, shipped, completed, ready_for_pickup, payment_failed, cancelled, refunded>[] | Yes | The approved kinds sendStoreOrderUpdate accepts. |
messages | StoreOrderMessage[] | Yes | — |
Errors this endpoint can return
401 · 422 · 429