marketplace
GET /v1/marketplace/orders/{sale_id}
The order workspace — one order, from your side of it.
Autenticación
Envía una clave de API como token de portador. Este endpoint no especifica un permiso concreto en la especificación, así que otorga a tu clave los mínimos privilegios necesarios y comprueba la respuesta en lugar de dar por sentado.
Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.
Pruébalo
Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.
curl -X GET https://api.zinndigital.com/v1/marketplace/orders/{sale_id} \
-H "Authorization: Bearer zdk_live_…"¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API
Detalles
docs/147 §3. The screen where the work actually happens, for whichever party is asking. Before this there was a buyer's list and a seller's money screen, and nowhere the work happened. The payload leads with `turn` and `waiting_on` because the screen does. The anti-jumble device is one question at the top — **whose turn is it, and what is it waiting for** — and it is computed in the engine so every client answers it identically rather than each deriving it from six columns. `paused` is the revision clock, made visible. Requesting a revision pauses the acceptance window by clearing its deadline, which is correct and completely unrenderable: a null deadline looks identical to a sale that never had one. The commission split is present for the SELLER and null for the buyer. To a buyer the price is the price.
Parámetros
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
sale_id (path) | string | Sí | — |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
sale_id | string | Sí | — |
state | string | Sí | — |
archetype | MarketplaceOrderArchetype | Sí | How this order behaves. Adding a CATEGORY is configuration; adding an ARCHETYPE is a build. Every order-side decision — whether a delivery clock exists, whether auto-accept appl… |
listing_title | string | No | — |
package_name | string | No | — |
turn | MarketplaceOrderTurn | Sí | Whose move it is. `staff` is a real answer, not a fallback: a disputed order is genuinely waiting on us, and telling a buyer "waiting for the seller" while a moderator holds it… |
waiting_on | MarketplaceOrderWaitingOn | Sí | What the order is waiting FOR — the half that makes `turn` actionable. |
is_yours | boolean | No | Whether the caller is the party being waited on. |
is_buyer | boolean | Sí | — |
deadline | string | No | The clock that is actually running, or null when none is. |
paused | boolean | No | A clock EXISTS but is stopped — the revision pause. Distinct from a null deadline, which also covers an order that never had a clock at all. |
overdue | boolean | No | Never true while `delivery_due_at` is null: null means the clock has not started, which is exactly the state of an order whose buyer has not written their brief yet. |
handover_confirmed | integer | No | — |
handover_required | integer | No | — |
outstanding | string[] | No | Question keys the buyer still owes. |
revisions_used | integer | No | — |
revisions_included | integer | No | — |
delivery_due_at | string | No | — |
currency | string | No | — |
gross_minor | integer | No | Integer minor units. Money is never a float. |
commission_minor | integer | No | The platform's commission, as its own figure. Present for the SELLER and null for the buyer — to a buyer the price is the price. The platform is merchant of record on every mark… |
vendor_net_minor | integer | No | What we owe the seller — a trade payable, not money held on trust. |
requirements_schema | object[] | No | The questions AS ASKED, frozen at purchase. A seller who rewrites their questions tomorrow cannot change what this buyer was asked. |
requirements | object | No | The buyer's answers, in the same `{key: {v: …}}` envelope. |
requirements_submitted_at | string | No | — |
handover_items | MarketplaceHandoverItem[] | No | — |
last_revision_reason | string | No | — |
Errores que este endpoint puede devolver
401 · 404