marketplace
GET /v1/marketplace/orders/{sale_id}/messages
The order chat.
Authentication
Send an API key as a bearer token. This endpoint checks no specific permission, so any key for your organisation can call it.
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/marketplace/orders/{sale_id}/messages \
-H "Authorization: Bearer zdk_live_…"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
docs/82 §4. A per-order conversation between buyer and seller, and staff on a dispute. Messages are part of the order record and are evidence in a dispute. A held message is excluded from both parties, not just the recipient: showing a sender their own held message as if it had been delivered is how someone concludes they are being ignored and leaves for email — the outcome the whole feature exists to avoid. Reading clears the caller's unread count.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
sale_id (path) | string | Yes | — |
locale (query) | string | No | BCP-47 language the reader is reading in (the app sends its UI locale). Used to translate communication text for this reader (docs/1067); verbatim text such as anchor texts and… |
cursor (query) | string | No | Opaque cursor from a previous page's page.next_cursor. |
limit (query) | integer | No | Maximum items to return (page size). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
data | MarketplaceMessage[] | Yes | — |
page | PageMeta | Yes | — |
Errors this endpoint can return
401 · 404