marketplace

POST `/v1/marketplace/orders/{sale_id}/dispute`

The buyer disputes an order — stops the acceptance clock and holds the payout.

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

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/marketplace/orders/{sale_id}/dispute \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "reason": <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

Buyer only (a seller receives 404). A reason is required. The sale moves to disputed, the auto-accept deadline is cleared, no path can release the seller's payable until staff decide, and the seller, the buyer and marketplace staff are notified.

Parameters

Name	Type	Required	What it is
`sale_id (path)`	`string`	Yes	—

Request body

Name	Type	Required	What it is
`reason`	`string`	Yes	—

Response

Name	Type	Required	What it is
`sale_id`	`string`	Yes	—
`state`	`string`	Yes	—
`is_buyer`	`boolean`	Yes	—
`can_raise`	`boolean`	Yes	—
`refusal_code`	`object`	Yes	—
`dispute`	`object`	Yes	—

Errors this endpoint can return

401 · 404 · 422

POST /v1/marketplace/orders/{sale_id}/dispute