Cancel a bid
Cancel one of your live Cru bids by its code. A partner credential sends its reference in a JSON body.
How this write runs
bid.cancel| Partner credentialCLIENT-KEY · CLIENT-SECRET | Executes at once and answers 200. The body must carry a reference: send the identical request again after a timeout and Cru replays the first outcome instead of acting twice. |
| Connected appAuthorization: Bearer | Answers 202 with a confirmation code and does nothing else. It runs only when the app calls POST /confirmations/{code} within 15 minutes, after the customer agrees. |
Writes & confirmations, in full →
Path parameter
REQUIRED| codestring | The bid’s opaque code, from GET /bids. URL-encode it as a single path segment. |
Request body
APPLICATION/JSON| FIELD | DESCRIPTION |
|---|---|
| referencestring · 1–50 chars · partners: required | Your idempotency key: letters and digits, then . _ : or - allowed. Required on a partner credential’s write and kept for good, so a retry with it can never act twice. Ignored for connected apps. |
Any other field is refused with VALIDATION_UNKNOWN_PARAMETER / 400.
A partner credential’s cancel must carry {"reference": "…"} as its JSON body. Check that your HTTP client sends a body on DELETE — not every client does by default.
Response fields
200 OK · 202 AcceptedThe cancelled bid, with status cancelled — or, for a connected app, a confirmation whose preview quotes the bid in your market’s currency.
Executed 200
actionstring
The action that ran, such as bid.place.
statusstring
completed.
bidobject
The bid, now cancelled.
Staged 202
confirmation.codestring
cnf_ and 43 more characters. A secret: the only handle on the instruction, valid for 15 minutes, once.
confirmation.actionstring
The action staged, such as bid.place.
confirmation.statusstring
pending.
confirmation.expires_atdatetime
RFC 3339 UTC.
confirmation.previewobject
summary, code, lwin18, wine_name, price, quantity and currency.
Errors
A code that is not one of your bids returns BID_NOT_FOUND / 404. A bid that is no longer live, a bid from another venue, and a bid part way through a trade cannot be cancelled and return TRADE_REFUSED / 422. Missing or invalid credentials return AUTH_INVALID_CREDENTIALS / 401. A credential without bids:write gets AUTH_INSUFFICIENT_SCOPE / 403. View all error codes →