Summarize sales
A period's confirmed and completed sales, by sale date: totals per currency, net sales by month, and the top five buyers and artists. The period defaults to this year so far. Use this, not paging the sales list, to answer how sales have gone.
A period's confirmed and completed sales, by sale date: totals per currency, net sales by month, and the top five buyers and artists. The period defaults to this year so far. Use this, not paging the sales list, to answer how sales have gone.
Authorization
bearerAuth sales:read, contacts:read, artworks:read, artists:readA gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: sales:read, contacts:read, artworks:read, artists:read
Query Parameters
First sale date counted (YYYY-MM-DD), inclusive. Defaults to January 1 of the current year.
^\d{4}-\d{2}-\d{2}$Last sale date counted (YYYY-MM-DD), inclusive. Defaults to today.
^\d{4}-\d{2}-\d{2}$Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
{ "from": "string", "to": "string", "sales_count": -9007199254740991, "totals": [ { "currency": "string", "sales_count": -9007199254740991, "gross_cents": -9007199254740991, "discount_cents": -9007199254740991, "net_cents": -9007199254740991 } ], "by_month": [ { "month": "string", "currency": "string", "sales_count": -9007199254740991, "net_cents": -9007199254740991 } ], "top_buyers": [ { "contact_id": "string", "name": "string", "currency": "string", "sales_count": -9007199254740991, "net_cents": -9007199254740991 } ], "top_artists": [ { "artist_id": "string", "name": "string", "currency": "string", "works_count": -9007199254740991, "sold_cents": -9007199254740991 } ], "truncated": true}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}Get a sale's three-way split breakdown GET
Returns the per-party split of a sale, net of production costs: the consignor and third-party legs (mirroring the generated payables) plus the gallery's residual consignee share, with amounts booked at the sale's frozen rate. A missing or unauthorized sale is a 404.
Add a tag to a sale POST
Adds a single tag to this sale (idempotent — never clobbers its other tags). Returns the resulting tag set.