Gallery Platform API
Reference

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.

POST
/gallery/consignments/{id}/end

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:update
AuthorizationBearer <token>

A gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).

In: header

Scope: artworks:update

Path Parameters

id*string

The consignment id.

Query Parameters

dry_run?boolean

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

Idempotency-Key?string

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"}