End a consignment
Ends a consignment: `ended_reason` (`returned`, `sold`, `transferred` or `other`) and `ended_on`, today when left out. The consignment stays in the history as ended. An inbound consignment ended `returned` derives the work as ex-inventory and returned; the database derives it in the same transaction. A consignment that already ended answers 409.
Ends a consignment: ended_reason (returned, sold, transferred or other) and ended_on, today when left out. The consignment stays in the history as ended. An inbound consignment ended returned derives the work as ex-inventory and returned; the database derives it in the same transaction. A consignment that already ended answers 409.
Authorization
bearerAuth artworks:updateA gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: artworks:update
Path Parameters
The consignment id.
Query Parameters
Preview this operation without committing it. When true, the request is authenticated, scoped, and validated, but no side effect runs — no write, no idempotency claim, no audit event, no outbound delivery. The response is HTTP 200 with an X-Dry-Run: true header and a body of { "dry_run": true }, plus an effect object describing what the real call would change when this operation can resolve one.
Header Parameters
Optional. Send a unique key per logical operation to make retries safe: a retry with the same key replays the stored success for 14 days instead of re-running the write. Reusing a key with a different body returns 400.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
End a consignment: why, and on what day.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
{ "id": "string", "artwork_id": "string", "direction": "string", "counterparty_contact_id": "string", "consignor_share_bps": -9007199254740991, "consignee_share_bps": -9007199254740991, "third_party_share_bps": -9007199254740991, "net_price_cents": -9007199254740991, "start_date": "string", "end_date": "string", "notes": "string", "signed_on": "string", "ended_on": "string", "ended_reason": "string", "created_at": "string", "updated_at": "string"}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}Delete a consignment DELETE
Permanently deletes a consignment's terms. This is a hard delete — to wind a term down instead, end it with `POST /gallery/consignments/{id}/end`.
List consignments GET
Lists the gallery's consignment terms across all artworks, newest first, with cursor pagination. Filter by `direction` (in/out), `counterparty_contact_id`, or `expiring_before` (an `end_date` on or before a date — the 'lapsing soon' view).