Gallery Platform API
Reference

Delete a consignment

Permanently deletes a consignment's terms. This is a hard delete — to wind a term down instead, set its end_date via PATCH.

DELETE
/gallery/consignments/{id}

Permanently deletes a consignment's terms. This is a hard delete — to wind a term down instead, set its end_date via PATCH.

Authorization

bearerAuth artworks:delete
AuthorizationBearer <token>

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

In: header

Scope: artworks:delete

Path Parameters

id*string

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.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

{  "id": "string",  "deleted": true}

Withdraw a consignment proposal POST

Withdraws a live proposal from the proposing side before the counterpart decides.

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).