Gallery Platform API
Reference

Cancel a sale

Cancels a draft or confirmed sale. Its works are released and its pending payables are voided in the same request. A canceled sale cannot be confirmed again. A completed, refunded or canceled sale answers 409.

POST
/gallery/sales/{id}/cancel

Cancels a draft or confirmed sale. Its works are released and its pending payables are voided in the same request. A canceled sale cannot be confirmed again. A completed, refunded or canceled sale answers 409.

Authorization

bearerAuth sales:update
AuthorizationBearer <token>

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

In: header

Scope: sales:update

Path Parameters

id*string

The sale 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.

Cancel a draft or confirmed sale.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

{  "id": "string",  "buyer_contact_id": "string",  "sold_by": "string",  "status": "draft",  "currency": "string",  "sale_date": "string",  "gross_cents": -9007199254740991,  "discount_cents": -9007199254740991,  "net_cents": -9007199254740991,  "fx_as_of": "string",  "fx_usd_per_unit": 0,  "fx_base_currency": "string",  "fx_base_usd_per_unit": 0,  "base_amount_cents": -9007199254740991,  "notes": "string",  "metadata": {    "property1": "string",    "property2": "string"  },  "created_at": "string",  "updated_at": "string",  "items": [    {      "id": "string",      "artwork_id": "string",      "list_price_cents": -9007199254740991,      "discount_cents": -9007199254740991,      "sold_price_cents": -9007199254740991,      "consignor_share_bps": 0,      "consignee_share_bps": 0,      "third_party_share_bps": 0,      "consignor_net_price_cents": 0,      "metadata": {        "property1": "string",        "property2": "string"      },      "created_at": "string"    }  ]}