marketplace

GET /v1/marketplace/orders/{sale_id}/messages

The order chat.

All marketplace endpoints

All developer docs →

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

NameTypeRequiredWhat it is
sale_id (path)stringYes—
locale (query)stringNoBCP-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)stringNoOpaque cursor from a previous page's page.next_cursor.
limit (query)integerNoMaximum items to return (page size).

Response

NameTypeRequiredWhat it is
dataMarketplaceMessage[]Yes—
pagePageMetaYes—

Errors this endpoint can return

401 · 404