Gallery Platform API
Reference

Consign an artwork in

Records an inbound consignment on the artwork: the consignor (`counterparty_contact_id`), the day the agreement was signed (`signed_on`, required), the shares in basis points, an optional flat net price, and the term's dates. `start_date` is the day the work arrives. The work reads as consigned in from `signed_on`, within the term; the database derives it in the same transaction. Needs `contacts:read` to resolve the consignor.

POST
/gallery/artworks/{id}/consign-in

Records an inbound consignment on the artwork: the consignor (counterparty_contact_id), the day the agreement was signed (signed_on, required), the shares in basis points, an optional flat net price, and the term's dates. start_date is the day the work arrives. The work reads as consigned in from signed_on, within the term; the database derives it in the same transaction. Needs contacts:read to resolve the consignor.

Authorization

bearerAuth artworks:create, contacts:read
AuthorizationBearer <token>

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

In: header

Scope: artworks:create, contacts:read

Path Parameters

id*string

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

Consign an artwork in: the consignor, the signing date, the shares and the term.

Response Body

application/json

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

{  "dry_run": true,  "effect": {    "summary": "string",    "count": 0,    "targets": [      {        "type": "string",        "id": "string",        "label": "string"      }    ],    "amount": {      "minor": -9007199254740991,      "currency": "str"    },    "details": {      "property1": "string",      "property2": "string"    },    "irreversible": true  }}