Update a publication
Patches a publication's fields (bibliographic, stock, availability, visibility, price). Only supplied fields change; `published` toggles its published_at.
Patches a publication's fields (bibliographic, stock, availability, visibility, price). Only supplied fields change; published toggles its published_at.
Authorization
bearerAuth publications:updateA gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: publications:update
Path Parameters
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.
Patch a publication (only supplied fields change).
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
{ "id": "string", "title": "string", "subtitle": "string", "publisher": "string", "isbn": "string", "editor": "string", "author": "string", "page_count": -9007199254740991, "publication_year": -9007199254740991, "dimensions_text": "string", "inventory_number": "string", "description": "string", "stock_quantity": -9007199254740991, "availability_state": "available", "cover_image_path": "string", "published_at": "string", "visibility": "public", "show_price_publicly": true, "price_cents": -9007199254740991, "currency": "string", "metadata": { "property1": "string", "property2": "string" }, "created_at": "string", "updated_at": "string"}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}List publications GET
Lists the gallery's publications (books, catalogues, editioned multiples) with cursor pagination. Filter by `visibility` or `availability_state`, fetch an explicit set with `ids` (comma-separated, max 50), or search with `q` — matches the title and inventory number. A read-only key sees only published, public/unlisted publications; each carries its price only when public-priced.
Render the consignment report PDF POST
Renders the gallery's artworks-on-consignment report — the terms (direction, splits, counterparty, dates) for every consigned work — to a branded PDF and returns a short-lived signed download URL.