{"openapi":"3.1.0","info":{"title":"Sherpo merchant API","version":"1","description":"Rich text fields take HTML in a closed format; anything else is refused as invalid, naming the field's path and the reason, so fix it and retry. Allowed: p, h1 (Title), h2 (Heading), h3 (Subheading), br; marks strong, em, u, s, sup, sub, code (b as strong, i as em, del as s, strike as s); a with href (http, https, mailto, tel, ftp, ftps, callto, sms, cid, xmpp, irc, ircs or a relative path), target=\"_blank\"; span with style color or background-color (#rgb or #rrggbb); style text-align (left, center, right, justify) on p and h1 to h3; ul; ol (start); li (data-checked=\"true\" or \"false\" for a task list); table, thead, tbody, tr, th, td (colspan, rowspan); pre with one code (class=\"language-<id>\", the id one of bash, c, cpp, csharp, css, go, xml, java, javascript, json, kotlin, markdown, php, python, ruby, rust, sql, swift, typescript, yaml); blockquote; hr; details (open) with its summary first; figure with at most one figcaption, first or last; a link's rel (noopener, noreferrer, nofollow) is read and never stored. Images, videos, audio, slideshows, formulas, diagrams, downloads and other blocks are <block type=\"…\" props=\"{…JSON…}\"></block> elements (no raw img or video); which types a field takes is in its description. getBodySchema answers each block's props, their values and which are required, for every kind of body; a block with an unknown type, an unknown prop or a value outside its set is refused, naming the block and what the prop takes. Refused: any other tag, attribute or style (div, section, img, iframe, script, comments…), a link or a block inside a link, a figure inside a figure. At most 1 MiB of UTF-8 (and each field's own limit), markup nested at most 32 deep, tables covering at most 10000 cells in all (each its rows times its widest row, spans counted). Reads return the stored canonical form, wrapped in <rich-text version=\"1\">; send it back as it is to keep a text. To write Markdown instead, set text_format to \"markdown\": each text, up to 64 KiB, is converted into the format, raw HTML in it kept, a $$ fence or a paragraph that is one $$ … $$ line a formula block (a fence nothing closes stays text), and a mermaid fence a diagram block (one of a type the store's page doesn't draw, or that the diagram rules refuse, stays code; one that still can't be drawn, or past 10 new diagrams in a save, is refused), and validated the same way; a Markdown image is refused, since an image is a block. Example: <h1>Welcome</h1><p style=\"text-align: center\">Start with <strong>the intro</strong>, then <a href=\"https://example.com/notes\" target=\"_blank\">read the notes</a>.</p><ul><li data-checked=\"true\"><p>Watch the intro</p></li><li data-checked=\"false\"><p>Take the <span style=\"color: #047857\">quiz</span></p></li></ul><details><summary>Why it works</summary><p>Short lessons stick.</p></details> The guide: https://api.sherpo.io/merchant/docs/text."},"servers":[{"url":"https://api.sherpo.io/merchant"}],"paths":{"/v1/stores/{store}/bulk":{"post":{"operationId":"bulk","summary":"Runs one bulk-capable change over many rows in one transaction, answering each item's outcome.","tags":["store"],"security":[{"bearer":[]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Runs one bulk-capable change over many rows in one transaction, answering each item's outcome.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"outcome":{"type":"string","const":"done"}},"required":["outcome"]},{"type":"object","properties":{"outcome":{"type":"string","const":"refused"},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","const":"internal"},"detail":{"type":"object","properties":{}}},"required":["code","detail"]},{"type":"object","properties":{"code":{"type":"string","const":"not_found"},"detail":{"type":"object","properties":{"kind":{"type":"string"},"ref":{"type":"object","properties":{},"additionalProperties":{"type":"string"}}},"required":["kind","ref"]}},"required":["code","detail"]},{"type":"object","properties":{"code":{"type":"string","const":"not_entitled"},"detail":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry","quiz","attachment","portfolio"]},"id":{"type":"string"}},"required":["kind","id"]}},"required":["code","detail"]},{"type":"object","properties":{"code":{"type":"string","const":"not_permitted"},"detail":{"anyOf":[{"type":"object","properties":{"reason":{"type":"string","x-extensible-enum":["paused","scope","credential","principal","plan","suspended"]}},"required":["reason"]},{"type":"object","properties":{"reason":{"type":"string","const":"suspended"},"hostname":{"description":"The store's own subdomain, where a visitor on another of its hostnames is sent meanwhile.","type":"string"}},"required":["reason"]},{"type":"object","properties":{"reason":{"type":"string","const":"limit"},"retry_at":{"description":"When the limit lifts, where core knows it.","type":"string","format":"date-time"}},"required":["reason"]}]}},"required":["code","detail"]},{"type":"object","properties":{"code":{"type":"string","const":"conflict"},"detail":{"anyOf":[{"type":"object","properties":{"field":{"type":"string","x-extensible-enum":["value","published","menu","internal","external","items"]},"current":{"type":"number"},"path":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}},"reason":{"type":"string"}},"required":["field"]},{"type":"object","properties":{"field":{"type":"string","x-extensible-enum":["symbol","name","key","slug","section","asset","customer","source_key","code","tier","processor_ref","attempts","member","email","role","body","staff","path","event","scope","quiz","request","plan","attachment","delivery","attachments","grant_ref","bindings"]},"current":{"type":"string"},"path":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}},"reason":{"type":"string"}},"required":["field"]},{"type":"object","properties":{"field":{"type":"string","x-extensible-enum":["status","category","kind"]},"current":{"type":"string"},"path":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}},"reason":{"type":"string"}},"required":["field"]},{"type":"object","properties":{"field":{"type":"string","const":"revision"},"current":{"anyOf":[{"type":"string"},{"type":"null"}]},"path":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}},"reason":{"type":"string"}},"required":["field","current"]},{"type":"object","properties":{"field":{"type":"string","const":"kind"},"current":{"type":"string","const":"secured"},"level":{"type":"string","x-extensible-enum":["basic","full"]},"path":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}},"reason":{"type":"string"}},"required":["field","current","level"]},{"type":"object","properties":{"field":{"type":"string","const":"mime"},"current":{"type":"string"},"path":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}},"reason":{"type":"string"}},"required":["field"]},{"type":"object","properties":{"field":{"type":"string","const":"idempotency_key"},"current":{"type":"string","const":"applied"},"path":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}},"reason":{"type":"string"}},"required":["field"]},{"type":"object","properties":{"field":{"type":"string","x-extensible-enum":["text","questions"]},"path":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}},"reason":{"type":"string"}},"required":["field"]},{"type":"object","properties":{"field":{"type":"string","const":"entries"},"path":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}},"reason":{"type":"string"}},"required":["field"]},{"type":"object","properties":{"field":{"type":"string","x-extensible-enum":["video","audio","poster"]},"path":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}},"reason":{"type":"string"}},"required":["field"]},{"type":"object","properties":{"field":{"type":"string","x-extensible-enum":["product","asset","discount","tier","entry","price","quiz","certificate","affiliate","event_session"]},"blocked_by":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"count":{"type":"number"}},"required":["kind","count"]}},"path":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}},"reason":{"type":"string"}},"required":["field","blocked_by"]}]}},"required":["code","detail"]},{"type":"object","properties":{"code":{"type":"string","const":"invalid"},"detail":{"type":"object","properties":{"path":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}},"reason":{"type":"string"},"offset":{"description":"For a rich text refused, where in the text the format stopped.","type":"integer","minimum":0},"name":{"description":"For a rich text refused, the tag, attribute or style the reason names.","type":"string"}},"required":["path","reason"]}},"required":["code","detail"]}]}},"required":["outcome","error"]}]}}},"required":["results"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accessor":{"type":"string","enum":["publishProduct","unpublishProduct","discontinueProduct","reinstateProduct","unlistProduct","relistProduct","deleteProduct","publishEntry","unpublishEntry","deleteEntry","publishPage","unpublishPage","deletePage","deleteAsset","archiveDiscount","restoreDiscount","deleteDiscount","disableLicense","enableLicense","recordLicense","hideReview","unhideReview"]},"items":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"minItems":1,"maxItems":50}},"required":["accessor","items"],"additionalProperties":false,"oneOf":[{"properties":{"accessor":{"const":"publishProduct"},"items":{"items":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]},"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true},"at":{"type":"string","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})(?:T(\\d{2}):(\\d{2})(?::(\\d{2})(?:\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"}},"required":["product"],"additionalProperties":false}}}},{"properties":{"accessor":{"const":"unpublishProduct"},"items":{"items":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]},"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true}},"required":["product"],"additionalProperties":false}}}},{"properties":{"accessor":{"const":"discontinueProduct"},"items":{"items":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]},"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true}},"required":["product"],"additionalProperties":false}}}},{"properties":{"accessor":{"const":"reinstateProduct"},"items":{"items":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]},"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true}},"required":["product"],"additionalProperties":false}}}},{"properties":{"accessor":{"const":"unlistProduct"},"items":{"items":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]},"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true}},"required":["product"],"additionalProperties":false}}}},{"properties":{"accessor":{"const":"relistProduct"},"items":{"items":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]},"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true}},"required":["product"],"additionalProperties":false}}}},{"properties":{"accessor":{"const":"deleteProduct"},"items":{"items":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]}},"required":["product"],"additionalProperties":false}}}},{"properties":{"accessor":{"const":"publishEntry"},"items":{"items":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]},"entry":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]},"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["product","slug"],"additionalProperties":false}]},"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true},"at":{"type":"string","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})(?:T(\\d{2}):(\\d{2})(?::(\\d{2})(?:\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"},"expect":{"description":"The status the caller saw; one that moved meanwhile, as a post taken down elsewhere, refuses.","type":"string","enum":["draft","scheduled","published"]}},"required":["product","entry"],"additionalProperties":false}}}},{"properties":{"accessor":{"const":"unpublishEntry"},"items":{"items":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]},"entry":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]},"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["product","slug"],"additionalProperties":false}]},"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true}},"required":["product","entry"],"additionalProperties":false}}}},{"properties":{"accessor":{"const":"deleteEntry"},"items":{"items":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]},"entry":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]},"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["product","slug"],"additionalProperties":false}]},"discard_progress":{"description":"Lets what customers did in it (completions, quiz sittings) and its notifications go with it; needs `customer:write` and `organization:write`.","type":"boolean","const":true}},"required":["product","entry"],"additionalProperties":false}}}},{"properties":{"accessor":{"const":"publishPage"},"items":{"items":{"type":"object","properties":{"page":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]},"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true},"at":{"type":"string","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})(?:T(\\d{2}):(\\d{2})(?::(\\d{2})(?:\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"}},"required":["page"],"additionalProperties":false}}}},{"properties":{"accessor":{"const":"unpublishPage"},"items":{"items":{"type":"object","properties":{"page":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]},"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true},"expect":{"description":"The status the caller saw; one that moved meanwhile, as a schedule that went live, refuses.","type":"string","enum":["scheduled","published"]}},"required":["page"],"additionalProperties":false}}}},{"properties":{"accessor":{"const":"deletePage"},"items":{"items":{"type":"object","properties":{"page":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]}},"required":["page"],"additionalProperties":false}}}},{"properties":{"accessor":{"const":"deleteAsset"},"items":{"items":{"type":"object","properties":{"asset":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"detach":{"type":"boolean"},"bindings":{"description":"The digest `getAsset` answers.","type":"string","minLength":64,"maxLength":64,"pattern":"^[0-9a-f]{64}$"}},"required":["asset"],"additionalProperties":false}}}},{"properties":{"accessor":{"const":"archiveDiscount"},"items":{"items":{"type":"object","properties":{"discount":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"required":["discount"],"additionalProperties":false}}}},{"properties":{"accessor":{"const":"restoreDiscount"},"items":{"items":{"type":"object","properties":{"discount":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"required":["discount"],"additionalProperties":false}}}},{"properties":{"accessor":{"const":"deleteDiscount"},"items":{"items":{"type":"object","properties":{"discount":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"required":["discount"],"additionalProperties":false}}}},{"properties":{"accessor":{"const":"disableLicense"},"items":{"items":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]},"license":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"reason":{"description":"Why, kept with the license and told in its event.","anyOf":[{"type":"string","minLength":1,"maxLength":500},{"type":"null"}]}},"required":["product","license"],"additionalProperties":false}}}},{"properties":{"accessor":{"const":"enableLicense"},"items":{"items":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]},"license":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"required":["product","license"],"additionalProperties":false}}}},{"properties":{"accessor":{"const":"recordLicense"},"items":{"items":{"type":"object","properties":{"customer":{"description":"By id, or by email: whoever the address reaches, else a new invited customer.","anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"email":{"type":"string","minLength":1,"maxLength":254,"pattern":"^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$"}},"required":["email"],"additionalProperties":false}]},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]},"key":{"description":"The key as the old platform issued it, kept verbatim; a hex key matches in any case and spacing, any other exactly.","type":"string","minLength":6,"maxLength":128,"pattern":"^[A-Za-z0-9._-]*[A-Za-z0-9][A-Za-z0-9._-]*$"},"uses":{"description":"How many times software checked it so far; a replace keeps the replaced license's by default.","type":"integer","minimum":0,"maximum":1000000000},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"disabled":{"description":"Record it disabled, as for a key refunded or turned off at the old platform; defaults to false, or to the replaced license's state.","type":"boolean"},"disabled_reason":{"description":"Why it is disabled; only with `disabled`.","anyOf":[{"type":"string","minLength":1,"maxLength":500},{"type":"null"}]},"replace":{"description":"Take the place of the customer's live license for the product, keeping its limit, which then reads as replaced. Defaults to false.","type":"boolean"}},"required":["customer","product","key"],"additionalProperties":false}}}},{"properties":{"accessor":{"const":"hideReview"},"items":{"items":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]},"review":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"required":["product","review"],"additionalProperties":false}}}},{"properties":{"accessor":{"const":"unhideReview"},"items":{"items":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]},"review":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"required":["product","review"],"additionalProperties":false}}}}]}}}}}},"/v1/stores/{store}/categories":{"get":{"operationId":"listCategories","summary":"Lists the product categories the store may use.","tags":["product"],"security":[{"bearer":["product:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Lists the product categories the store may use.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"enabled":{"type":"boolean"},"id":{"type":"string"},"label":{"type":"string"},"discountable":{"type":"boolean"},"subscribable":{"type":"boolean"},"reviewable":{"type":"boolean"},"repeatable":{"description":"Bought again and again: a coffee, a donation, an invoice, a seat, a slot.","type":"boolean"},"aside_size":{"type":"string","x-extensible-enum":["small","none","large"]}},"required":["enabled","id","label","discountable","subscribable","reviewable","repeatable","aside_size"]}}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products":{"get":{"operationId":"listProducts","summary":"Pages the store's products.","tags":["product"],"security":[{"bearer":["product:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","description":"Sorted by published or rating, rows without a value come last either way.","schema":{"type":"string","enum":["catalog","created","published","title","priority","sales","rating"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"search","in":"query","schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"facets","in":"query","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["status","unlisted"]}}}],"responses":{"200":{"description":"Pages the store's products.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"event_map":{"description":"An event's venue maps at its location's point, one image per theme; null until drawn, or for any other product.","anyOf":[{"type":"object","properties":{"light":{"description":"For a light page.","type":"object","properties":{"url":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"resized":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"width":{"type":"number"},"avif":{"type":"string"},"webp":{"type":"string"}},"required":["width","avif","webp"]}},{"type":"null"}]}},"required":["url","width","height","resized"]},"dark":{"description":"For a dark page.","type":"object","properties":{"url":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"resized":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"width":{"type":"number"},"avif":{"type":"string"},"webp":{"type":"string"}},"required":["width","avif","webp"]}},{"type":"null"}]}},"required":["url","width","height","resized"]},"attribution":{"description":"The credit shown over the map, linking `attribution_url`.","type":"string"},"attribution_url":{"type":"string"}},"required":["light","dark","attribution","attribution_url"]},{"type":"null"}]},"seats":{"description":"An event's seats as the product read answers them: what frozen carts hold and sales took, each ticket type's too; null for another category.","anyOf":[{"type":"object","properties":{"capacity":{"anyOf":[{"type":"number"},{"type":"null"}]},"held":{"type":"number"},"sold":{"type":"number"},"spots_left":{"anyOf":[{"type":"number"},{"type":"null"}]},"sold_out":{"type":"boolean"},"tickets":{"type":"array","items":{"type":"object","properties":{"tier_id":{"type":"string"},"capacity":{"anyOf":[{"type":"number"},{"type":"null"}]},"held":{"type":"number"},"sold":{"type":"number"},"spots_left":{"anyOf":[{"type":"number"},{"type":"null"}]},"sold_out":{"type":"boolean"}},"required":["tier_id","capacity","held","sold","spots_left","sold_out"]}}},"required":["capacity","held","sold","spots_left","sold_out","tickets"]},{"type":"null"}]},"sales":{"type":"number"},"rating":{"type":"object","properties":{"count":{"type":"number"},"average":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["count","average"]},"poster":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"target":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"}},"required":["kind","id"]},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"from_body":{"type":"boolean"},"release_file":{"description":"A file a software release ships, which its release edits and the product's own list leaves out.","type":"boolean"},"position":{"type":"number"},"asset":{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]},"url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","target","role","delivery","preview_only","from_body","release_file","position","asset","url"]},{"type":"null"}]},"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The storefront path.","type":"string"},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"subtitle":{"description":"The short line shown under the title.","anyOf":[{"type":"string"},{"type":"null"}]},"category":{"type":"string"},"listing":{"type":"string","x-extensible-enum":["primary","secondary"]},"priority":{"type":"number"},"status":{"type":"string","x-extensible-enum":["draft","scheduled","published","discontinued"]},"unlisted":{"type":"boolean"},"feed_url":{"description":"The public feed's absolute URL, for a blog or a podcast that is published (discontinued too), listed and on a verified hostname; else null.","anyOf":[{"type":"string"},{"type":"null"}]},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"discontinued_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"unlisted_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"refund_policy":{"type":"string","x-extensible-enum":["none","24h","72h","7d","14d","30d"]},"progress_tracking":{"type":"string","x-extensible-enum":["manual","disabled","on_open","on_complete"]},"reviews_enabled":{"type":"boolean"},"review_summary_visible":{"description":"Whether customers see the generated review summary; it is written either way.","type":"boolean"},"purchase_note":{"description":"Shown beside the buy button.","type":"string","minLength":1,"maxLength":2000},"approval":{"description":"Whether each buyer waits as a pending request until the seller approves or declines it; none when unset.","type":"string","x-extensible-enum":["none","required"]},"approval_payment":{"description":"How a paid purchase waits for approval; saved_card when unset. Holds last about 7 days on a card.","type":"string","x-extensible-enum":["saved_card","hold"]},"calendar":{"description":"A bookable product: the seller's Cal.com event and the host card beside the widget; writes check it, reads answer it as stored.","type":"object","properties":{"calcom":{"type":"object","properties":{"username":{"type":"string"},"event_slug":{"type":"string"}}},"host":{"type":"object","properties":{"identity":{"description":"Set apart from `title`: a write of either clears the other.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"member"},"user":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["kind","user"]},{"type":"object","properties":{"kind":{"type":"string","const":"business"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"store"}},"required":["kind"]}]},"title":{"type":"string"},"subtitle":{"type":"string"},"description":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}}}},"coffee":{"description":"A tip button: what it is called and what it shows.","type":"object","properties":{"emoji":{"type":"string"},"descriptor":{"type":"string","minLength":3,"maxLength":15,"pattern":"^\\S(.*\\S)?$"}}},"software":{"description":"A software product: how its license keys start and how many devices each holds by default.","type":"object","properties":{"key_prefix":{"description":"Letters and digits, single hyphens or underscores between them.","type":"string","minLength":1,"maxLength":16,"pattern":"^[A-Za-z0-9]+(?:[-_][A-Za-z0-9]+)*$"},"activation_limit":{"description":"The devices a license activates at once by default; none means no limit.","type":"integer","minimum":1,"maximum":10000},"inactive_days":{"description":"Days after which a device the software stopped reporting no longer counts; none keeps it until freed.","type":"integer","minimum":1,"maximum":3650},"offline_days":{"description":"Days a signed license token lets the software run offline before it asks again; 30 when unset.","type":"integer","minimum":1,"maximum":365}}},"event":{"description":"An event product: how it is attended, where, and how it takes guests.","type":"object","properties":{"format":{"description":"In person, online or both; in person when unset.","type":"string","x-extensible-enum":["in_person","online","hybrid"]},"location":{"description":"Where an in-person event takes place.","type":"object","properties":{"venue":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":200,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"address":{"description":"The street address, trimmed, its lines apart and no other control character.","type":"string","minLength":1,"maxLength":500,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u0009\\u000b\\u000c\\u000e-\\u001f\\u007f-\\u009f]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"city":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":100,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"region":{"description":"A state, province or county. Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":100,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"postal_code":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":20,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"country":{"description":"ISO 3166-1 alpha-2, upper case.","type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Z]{2}$"},"latitude":{"description":"Where it is on a map, in decimal degrees, set together with `longitude`.","type":"number","minimum":-90,"maximum":90},"longitude":{"description":"Where it is on a map, in decimal degrees, set together with `latitude`.","type":"number","minimum":-180,"maximum":180},"map_url":{"description":"A map's page for the place. An https URL.","type":"string","minLength":1,"maxLength":2000,"pattern":"^https://"}}},"reveal_location":{"description":"Who sees the location: everyone, or ticket holders alone; everyone when unset.","type":"string","x-extensible-enum":["everyone","holders"]},"waitlist":{"description":"Whether guests may join a waitlist once it is full; not when unset.","type":"boolean"},"capacity":{"description":"How many guests it takes in all; none means no limit.","type":"integer","minimum":1,"maximum":1000000}}},"fundraising":{"description":"A fundraiser: the goal, in minor units of its currency.","type":"object","properties":{"goal":{"type":"integer","minimum":1},"currency":{"type":"string","minLength":3,"maxLength":3}},"required":["goal","currency"]},"feeds":{"description":"A blog's or a podcast's feeds: the public one always stays; `private` false turns every customer's private feed off.","type":"object","properties":{"private":{"type":"boolean"},"category":{"description":"A podcast's directory category, one of Apple's, its subcategory after ` > ` (`Arts > Books`).","type":"string","maxLength":64},"explicit":{"description":"Whether a podcast's episodes are explicit; not where unset.","type":"boolean"},"owner_email":{"description":"The address directories mail to verify a podcast's owner; never in a private feed.","type":"string","maxLength":254}}},"storefront":{"type":"object","properties":{"sales_counter":{"description":"A public count of orders on the product page.","type":"boolean"},"background_poster":{"description":"The poster doubles as the page background.","type":"boolean"},"require_dark":{"description":"The page renders dark whatever the visitor chose.","type":"boolean"}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["event_map","seats","sales","rating","poster","id","slug","path","url","title","subtitle","category","listing","priority","status","unlisted","feed_url","published_at","discontinued_at","unlisted_at","created_at","updated_at","settings","metadata"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"post":{"operationId":"createProduct","summary":"Creates a draft product.","tags":["product"],"security":[{"bearer":["product:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"201":{"description":"Creates a draft product.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","x-extensible-enum":["draft","scheduled","published","discontinued"]},"category":{"type":"string"},"listing":{"type":"string","x-extensible-enum":["primary","secondary"]},"id":{"type":"string"},"slug":{"type":"string"},"title":{"type":"string"},"subtitle":{"description":"The short line shown under the title.","anyOf":[{"type":"string"},{"type":"null"}]},"priority":{"type":"number"},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"discontinued_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"unlisted_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"refund_policy":{"type":"string","x-extensible-enum":["none","24h","72h","7d","14d","30d"]},"progress_tracking":{"type":"string","x-extensible-enum":["manual","disabled","on_open","on_complete"]},"reviews_enabled":{"type":"boolean"},"review_summary_visible":{"description":"Whether customers see the generated review summary; it is written either way.","type":"boolean"},"purchase_note":{"description":"Shown beside the buy button.","type":"string","minLength":1,"maxLength":2000},"approval":{"description":"Whether each buyer waits as a pending request until the seller approves or declines it; none when unset.","type":"string","x-extensible-enum":["none","required"]},"approval_payment":{"description":"How a paid purchase waits for approval; saved_card when unset. Holds last about 7 days on a card.","type":"string","x-extensible-enum":["saved_card","hold"]},"calendar":{"description":"A bookable product: the seller's Cal.com event and the host card beside the widget; writes check it, reads answer it as stored.","type":"object","properties":{"calcom":{"type":"object","properties":{"username":{"type":"string"},"event_slug":{"type":"string"}}},"host":{"type":"object","properties":{"identity":{"description":"Set apart from `title`: a write of either clears the other.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"member"},"user":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["kind","user"]},{"type":"object","properties":{"kind":{"type":"string","const":"business"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"store"}},"required":["kind"]}]},"title":{"type":"string"},"subtitle":{"type":"string"},"description":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}}}},"coffee":{"description":"A tip button: what it is called and what it shows.","type":"object","properties":{"emoji":{"type":"string"},"descriptor":{"type":"string","minLength":3,"maxLength":15,"pattern":"^\\S(.*\\S)?$"}}},"software":{"description":"A software product: how its license keys start and how many devices each holds by default.","type":"object","properties":{"key_prefix":{"description":"Letters and digits, single hyphens or underscores between them.","type":"string","minLength":1,"maxLength":16,"pattern":"^[A-Za-z0-9]+(?:[-_][A-Za-z0-9]+)*$"},"activation_limit":{"description":"The devices a license activates at once by default; none means no limit.","type":"integer","minimum":1,"maximum":10000},"inactive_days":{"description":"Days after which a device the software stopped reporting no longer counts; none keeps it until freed.","type":"integer","minimum":1,"maximum":3650},"offline_days":{"description":"Days a signed license token lets the software run offline before it asks again; 30 when unset.","type":"integer","minimum":1,"maximum":365}}},"event":{"description":"An event product: how it is attended, where, and how it takes guests.","type":"object","properties":{"format":{"description":"In person, online or both; in person when unset.","type":"string","x-extensible-enum":["in_person","online","hybrid"]},"location":{"description":"Where an in-person event takes place.","type":"object","properties":{"venue":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":200,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"address":{"description":"The street address, trimmed, its lines apart and no other control character.","type":"string","minLength":1,"maxLength":500,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u0009\\u000b\\u000c\\u000e-\\u001f\\u007f-\\u009f]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"city":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":100,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"region":{"description":"A state, province or county. Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":100,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"postal_code":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":20,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"country":{"description":"ISO 3166-1 alpha-2, upper case.","type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Z]{2}$"},"latitude":{"description":"Where it is on a map, in decimal degrees, set together with `longitude`.","type":"number","minimum":-90,"maximum":90},"longitude":{"description":"Where it is on a map, in decimal degrees, set together with `latitude`.","type":"number","minimum":-180,"maximum":180},"map_url":{"description":"A map's page for the place. An https URL.","type":"string","minLength":1,"maxLength":2000,"pattern":"^https://"}}},"reveal_location":{"description":"Who sees the location: everyone, or ticket holders alone; everyone when unset.","type":"string","x-extensible-enum":["everyone","holders"]},"waitlist":{"description":"Whether guests may join a waitlist once it is full; not when unset.","type":"boolean"},"capacity":{"description":"How many guests it takes in all; none means no limit.","type":"integer","minimum":1,"maximum":1000000}}},"fundraising":{"description":"A fundraiser: the goal, in minor units of its currency.","type":"object","properties":{"goal":{"type":"integer","minimum":1},"currency":{"type":"string","minLength":3,"maxLength":3}},"required":["goal","currency"]},"feeds":{"description":"A blog's or a podcast's feeds: the public one always stays; `private` false turns every customer's private feed off.","type":"object","properties":{"private":{"type":"boolean"},"category":{"description":"A podcast's directory category, one of Apple's, its subcategory after ` > ` (`Arts > Books`).","type":"string","maxLength":64},"explicit":{"description":"Whether a podcast's episodes are explicit; not where unset.","type":"boolean"},"owner_email":{"description":"The address directories mail to verify a podcast's owner; never in a private feed.","type":"string","maxLength":254}}},"storefront":{"type":"object","properties":{"sales_counter":{"description":"A public count of orders on the product page.","type":"boolean"},"background_poster":{"description":"The poster doubles as the page background.","type":"boolean"},"require_dark":{"description":"The page renders dark whatever the visitor chose.","type":"boolean"}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"unlisted":{"type":"boolean"},"in_use":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"count":{"type":"number"}},"required":["kind","count"]}},"poster":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"target":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"}},"required":["kind","id"]},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"from_body":{"type":"boolean"},"release_file":{"description":"A file a software release ships, which its release edits and the product's own list leaves out.","type":"boolean"},"position":{"type":"number"},"asset":{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}},"required":["id","target","role","delivery","preview_only","from_body","release_file","position","asset"]},{"type":"null"}]},"path":{"description":"The storefront path.","type":"string"},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one.","anyOf":[{"type":"string"},{"type":"null"}]},"tiers":{"type":"array","items":{"type":"object","properties":{"in_use":{"type":"object","properties":{"prices":{"type":"number"},"grants":{"type":"number"},"orders":{"type":"number"},"discounts":{"type":"number"},"gates":{"type":"number"}},"required":["prices","grants","orders","discounts","gates"]},"id":{"type":"string"},"product_id":{"type":"string"},"rank":{"type":"number"},"name":{"type":"string"},"settings":{"type":"object","properties":{"software":{"description":"A software tier: what its licenses unlock, answered by a license check.","type":"object","properties":{"features":{"description":"Distinct flags the seller's software reads: letters and digits, single hyphens, underscores, dots or colons between them.","type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9]+(?:[-_.:][A-Za-z0-9]+)*$"},"maxItems":100},"activation_limit":{"description":"The devices its licenses activate at once, over the product's default; none holds the product's.","type":"integer","minimum":1,"maximum":10000}}},"event":{"description":"An event's ticket type: how many guests it takes.","type":"object","properties":{"capacity":{"description":"How many guests this ticket type takes, within the event's own capacity; none means no limit of its own.","type":"integer","minimum":1,"maximum":1000000}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["in_use","id","product_id","rank","name","settings"]}},"prices":{"type":"array","items":{"type":"object","properties":{"in_use":{"type":"object","properties":{"orders":{"type":"number"},"subscriptions":{"type":"number"},"checkouts":{"type":"number"},"automations":{"type":"number"},"discounts":{"type":"number"}},"required":["orders","subscriptions","checkouts","automations","discounts"]},"id":{"type":"string"},"product_id":{"type":"string"},"tier_id":{"type":"string"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"type":"number"},"kind":{"type":"string","x-extensible-enum":["one_time","recurring"]},"period":{"anyOf":[{"type":"object","properties":{"unit":{"type":"string","x-extensible-enum":["day","week","month","year"]},"multiplier":{"type":"number"}},"required":["unit","multiplier"]},{"type":"null"}]},"highlighted":{"type":"boolean"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"autorenew":{"description":"Recurring only; false stops the renewal, absent renews.","type":"boolean"},"renewal_discount":{"description":"Recurring only, a percent off every renewal.","type":"integer","minimum":0,"maximum":100},"upgrade_multiplier":{"description":"One-time only, a factor on the difference paid to move up a tier.","type":"number","minimum":1,"maximum":10},"refund_policy":{"description":"Overrides the product's.","type":"string","x-extensible-enum":["none","24h","72h","7d","14d","30d"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["in_use","id","product_id","tier_id","currency","exponent","amount","kind","period","highlighted","title","description","settings","archived_at","created_at"]}},"delete_blocked_by":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"count":{"type":"number"}},"required":["kind","count"]}},"stats":{"type":"array","items":{"type":"object","properties":{"gross":{"anyOf":[{"type":"number"},{"type":"null"}]},"refunded":{"anyOf":[{"type":"number"},{"type":"null"}]},"platform_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"processor_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"affiliate_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"type":"string"},"settlement":{"type":"string","x-extensible-enum":["platform","seller","external"]},"transactions":{"type":"number"},"refunds":{"type":"number"},"buyers":{"type":"number"}},"required":["gross","refunded","platform_fee","processor_fee","affiliate_fee","exponent","currency","settlement","transactions","refunds","buyers"]}},"ratings":{"type":"object","properties":{"published":{"type":"object","properties":{"count":{"type":"number"},"average":{"anyOf":[{"type":"number"},{"type":"null"}]},"histogram":{"type":"object","properties":{"1":{"type":"number"},"2":{"type":"number"},"3":{"type":"number"},"4":{"type":"number"},"5":{"type":"number"}},"required":["1","2","3","4","5"]}},"required":["count","average","histogram"]},"live":{"type":"object","properties":{"hidden":{"type":"number"},"count":{"type":"number"},"average":{"anyOf":[{"type":"number"},{"type":"null"}]},"histogram":{"type":"object","properties":{"1":{"type":"number"},"2":{"type":"number"},"3":{"type":"number"},"4":{"type":"number"},"5":{"type":"number"}},"required":["1","2","3","4","5"]}},"required":["hidden","count","average","histogram"]}},"required":["published","live"]},"event_map":{"description":"An event's venue maps at its location's point, one image per theme; null until drawn, or for any other product.","anyOf":[{"type":"object","properties":{"light":{"description":"For a light page.","type":"object","properties":{"url":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"resized":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"width":{"type":"number"},"avif":{"type":"string"},"webp":{"type":"string"}},"required":["width","avif","webp"]}},{"type":"null"}]}},"required":["url","width","height","resized"]},"dark":{"description":"For a dark page.","type":"object","properties":{"url":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"resized":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"width":{"type":"number"},"avif":{"type":"string"},"webp":{"type":"string"}},"required":["width","avif","webp"]}},{"type":"null"}]}},"required":["url","width","height","resized"]},"attribution":{"description":"The credit shown over the map, linking `attribution_url`.","type":"string"},"attribution_url":{"type":"string"}},"required":["light","dark","attribution","attribution_url"]},{"type":"null"}]},"feed_url":{"description":"The public feed's absolute URL, for a blog or a podcast that is published (discontinued too), listed and on a verified hostname; else null.","anyOf":[{"type":"string"},{"type":"null"}]},"description":{"description":"The page's long description, in the rich text format as stored; answered only with `full`.","anyOf":[{"type":"string"},{"type":"null"}],"x-rich-text":"text"},"what_you_get":{"description":"What a buyer gets, in the rich text format as stored; answered only with `full`.","anyOf":[{"type":"string"},{"type":"null"}],"x-rich-text":"text"},"files":{"description":"The files its prose names; answered only with `full`.","type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["video","audio","image","pdf","file"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes, null when it has none or is withheld.","anyOf":[{"type":"number"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"description":"Seconds.","anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"url":{"description":"A public file's lasting URL, an image's naming its widths' version as `#v=` once they're made; null for a private one, or one whose bytes haven't landed.","anyOf":[{"type":"string"},{"type":"null"}]},"resized":{"description":"A public image's smaller copies, narrowest first, for a `srcset`; left out until they're made and its width measured, for one kept as uploaded, and for any other file.","type":"array","items":{"type":"object","properties":{"width":{"description":"Its width in pixels, at most the image's own.","type":"integer","minimum":1},"avif":{"description":"A lasting URL to it as AVIF.","type":"string"},"webp":{"description":"A lasting URL to it as WebP.","type":"string"}},"required":["width","avif","webp"]}},"attachment_id":{"description":"The binding a private file opens through; null when the reader can't open it.","anyOf":[{"type":"string"},{"type":"null"}]},"unlocks":{"description":"What unlocks a file its own rules keep from the reader, any one; null for any other file.","anyOf":[{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product_name":{"type":"string"},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]}},"required":["product_id","product_name","tier"]}},{"type":"null"}]},"video":{"description":"A video's subtitles and published AI outputs, where its read lists any and the reader may play it.","type":"object","properties":{"attachment_id":{"type":"string"},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["attachment_id","tracks","outputs"]},"audio":{"description":"An audio file's waveform, subtitles and published AI outputs, where the reader may play it.","type":"object","properties":{"waveform":{"description":"256 levels from 0 to 255, base64, from the file's start to its end; null until drawn, or when it can't be.","anyOf":[{"type":"string"},{"type":"null"}]},"attachment_id":{"description":"The binding its tracks and outputs open through, which a public file carries here alone; null with none.","anyOf":[{"type":"string"},{"type":"null"}]},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["waveform","attachment_id","tracks","outputs"]}},"required":["id","kind","mime","name","bytes","width","height","duration","pages","status","url","attachment_id","unlocks"]}},"created":{"description":"The attachments the write bound: the files its new prose names.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string","x-extensible-enum":["prose","teaser","embed"]},"asset":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["id","role","asset"]}}},"required":["status","category","listing","id","slug","title","subtitle","priority","published_at","discontinued_at","unlisted_at","created_at","updated_at","settings","metadata","unlisted","in_use","path","url","tiers","prices","delete_blocked_by","stats","ratings","event_map","feed_url","created"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text_format":{"type":"string","enum":["html","markdown"],"default":"html","description":"The format the rich text fields are written in: the rich text format’s HTML, or Markdown converted into it before it is validated. A text already stored in the format (starting with `<rich-text`) is kept as it is either way."},"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true},"slug":{"description":"Made from the title when absent: its words, numbered past a twin.","type":"string","minLength":1,"maxLength":120,"pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$"},"title":{"type":"string","minLength":1,"maxLength":200},"category":{"type":"string","minLength":1,"maxLength":64},"subtitle":{"description":"The short line shown under the title.","anyOf":[{"type":"string","minLength":1,"maxLength":100},{"type":"null"}]},"description":{"description":"The page's long description, a rich text (images, videos, audio, slideshows, formulas and diagrams only as blocks, an image it starts showing at most 15 MB) stored in its canonical form.","anyOf":[{"type":"string","minLength":1,"maxLength":100000},{"type":"null"}],"x-rich-text":"text"},"what_you_get":{"description":"What a buyer gets, a rich text (images, videos, audio, slideshows, formulas and diagrams only as blocks, an image it starts showing at most 15 MB) stored in its canonical form.","anyOf":[{"type":"string","minLength":1,"maxLength":100000},{"type":"null"}],"x-rich-text":"text"},"listing":{"type":"string","enum":["primary","secondary"]},"priority":{"type":"integer","minimum":0,"maximum":1000000},"settings":{"type":"object","properties":{"feeds":{"description":"A blog's or a podcast's feeds: the public one always stays; `private` false turns every customer's private feed off.","type":"object","properties":{"private":{"type":"boolean"},"category":{"description":"A podcast's directory category, one of Apple's, its subcategory after ` > ` (`Arts > Books`).","type":"string","maxLength":64},"explicit":{"description":"Whether a podcast's episodes are explicit; not where unset.","type":"boolean"},"owner_email":{"description":"The address directories mail to verify a podcast's owner; never in a private feed.","type":"string","maxLength":254}},"additionalProperties":false},"refund_policy":{"type":"string","enum":["none","24h","72h","7d","14d","30d"]},"progress_tracking":{"type":"string","enum":["manual","disabled","on_open","on_complete"]},"reviews_enabled":{"type":"boolean"},"review_summary_visible":{"description":"Whether customers see the generated review summary; it is written either way.","type":"boolean"},"purchase_note":{"description":"Shown beside the buy button.","type":"string","minLength":1,"maxLength":2000},"approval":{"description":"Whether each buyer waits as a pending request until the seller approves or declines it; none when unset.","type":"string","enum":["none","required"]},"approval_payment":{"description":"How a paid purchase waits for approval; saved_card when unset. Holds last about 7 days on a card.","type":"string","enum":["saved_card","hold"]},"fundraising":{"description":"A fundraiser: the goal, in minor units of its currency.","type":"object","properties":{"goal":{"type":"integer","minimum":1},"currency":{"type":"string","minLength":3,"maxLength":3}},"required":["goal","currency"],"additionalProperties":false},"storefront":{"type":"object","properties":{"sales_counter":{"description":"A public count of orders on the product page.","type":"boolean"},"background_poster":{"description":"The poster doubles as the page background.","type":"boolean"},"require_dark":{"description":"The page renders dark whatever the visitor chose.","type":"boolean"}},"additionalProperties":false},"event":{"description":"An event product: how it is attended, where, and how it takes guests.","anyOf":[{"type":"object","properties":{"format":{"description":"In person, online or both; in person when unset.","anyOf":[{"type":"string","enum":["in_person","online","hybrid"]},{"type":"null"}]},"location":{"description":"Where an in-person event takes place.","anyOf":[{"type":"object","properties":{"venue":{"description":"Trimmed, with no line break or control character.","anyOf":[{"type":"string","minLength":1,"maxLength":200,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},{"type":"null"}]},"address":{"description":"The street address, trimmed, its lines apart and no other control character.","anyOf":[{"type":"string","minLength":1,"maxLength":500,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u0009\\u000b\\u000c\\u000e-\\u001f\\u007f-\\u009f]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},{"type":"null"}]},"city":{"description":"Trimmed, with no line break or control character.","anyOf":[{"type":"string","minLength":1,"maxLength":100,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},{"type":"null"}]},"region":{"description":"A state, province or county. Trimmed, with no line break or control character.","anyOf":[{"type":"string","minLength":1,"maxLength":100,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},{"type":"null"}]},"postal_code":{"description":"Trimmed, with no line break or control character.","anyOf":[{"type":"string","minLength":1,"maxLength":20,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},{"type":"null"}]},"country":{"description":"ISO 3166-1 alpha-2, upper case.","anyOf":[{"type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Z]{2}$"},{"type":"null"}]},"latitude":{"description":"Where it is on a map, in decimal degrees, set together with `longitude`.","anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"description":"Where it is on a map, in decimal degrees, set together with `latitude`.","anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"map_url":{"description":"A map's page for the place. An https URL.","anyOf":[{"type":"string","minLength":1,"maxLength":2000,"pattern":"^https://"},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]},"reveal_location":{"description":"Who sees the location: everyone, or ticket holders alone; everyone when unset.","anyOf":[{"type":"string","enum":["everyone","holders"]},{"type":"null"}]},"waitlist":{"description":"Whether guests may join a waitlist once it is full; not when unset.","anyOf":[{"type":"boolean"},{"type":"null"}]},"capacity":{"description":"How many guests it takes in all; none means no limit.","anyOf":[{"type":"integer","minimum":1,"maximum":1000000},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]},"coffee":{"description":"A tip button: what it is called and what it shows.","anyOf":[{"type":"object","properties":{"emoji":{"anyOf":[{"type":"string"},{"type":"null"}]},"descriptor":{"anyOf":[{"type":"string","minLength":3,"maxLength":15,"pattern":"^\\S(.*\\S)?$"},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]},"software":{"description":"A software product: how its license keys start and how many devices each holds by default.","anyOf":[{"type":"object","properties":{"key_prefix":{"description":"Letters and digits, single hyphens or underscores between them.","anyOf":[{"type":"string","minLength":1,"maxLength":16,"pattern":"^[A-Za-z0-9]+(?:[-_][A-Za-z0-9]+)*$"},{"type":"null"}]},"activation_limit":{"description":"The devices a license activates at once by default; none means no limit.","anyOf":[{"type":"integer","minimum":1,"maximum":10000},{"type":"null"}]},"inactive_days":{"description":"Days after which a device the software stopped reporting no longer counts; none keeps it until freed.","anyOf":[{"type":"integer","minimum":1,"maximum":3650},{"type":"null"}]},"offline_days":{"description":"Days a signed license token lets the software run offline before it asks again; 30 when unset.","anyOf":[{"type":"integer","minimum":1,"maximum":365},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]},"calendar":{"description":"A bookable product: the seller's Cal.com event and the host card beside the widget.","anyOf":[{"type":"object","properties":{"calcom":{"anyOf":[{"type":"object","properties":{"username":{"description":"A path segment of a Cal.com link, as it stands in it; set with `event_slug`.","anyOf":[{"type":"string","minLength":1,"maxLength":100,"pattern":"^(?!\\.\\.?$)[A-Za-z0-9_.!~*'()-]+$"},{"type":"null"}]},"event_slug":{"description":"A path segment of a Cal.com link, as it stands in it; set with `username`.","anyOf":[{"type":"string","minLength":1,"maxLength":100,"pattern":"^(?!\\.\\.?$)[A-Za-z0-9_.!~*'()-]+$"},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]},"host":{"anyOf":[{"type":"object","properties":{"title":{"description":"Trimmed and well formed, with no line break or control character; writing it clears `identity`.","anyOf":[{"type":"string","minLength":1,"maxLength":120,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},{"type":"null"}]},"subtitle":{"description":"Trimmed and well formed, with no line break or control character.","anyOf":[{"type":"string","minLength":1,"maxLength":150,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},{"type":"null"}]},"description":{"description":"Trimmed and well formed, line feeds and carriage returns allowed but no other control character.","anyOf":[{"type":"string","minLength":1,"maxLength":500,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u0009\\u000b\\u000c\\u000e-\\u001f\\u007f-\\u009f]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},{"type":"null"}]},"tags":{"description":"Each trimmed and well formed, with no comma, line break or control character; at most 250 characters joined one per line.","anyOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":250,"pattern":"^[^\\s,\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029,]*[^\\s,\\u0000-\\u001f\\u007f-\\u009f])?$"}},{"type":"null"}]},"identity":{"description":"Who the card names, its name read when shown; writing it clears `title`.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"member"},"user":{"description":"A user holding a seat on the store's business now.","type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"required":["kind","user"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"business"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"store"}},"required":["kind"],"additionalProperties":false},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"object","properties":{"calcom":{"anyOf":[{"type":"object","properties":{"username":{"description":"A path segment of a Cal.com link, as it stands in it; set with `event_slug`.","anyOf":[{"type":"string","minLength":1,"maxLength":100,"pattern":"^(?!\\.\\.?$)[A-Za-z0-9_.!~*'()-]+$"},{"type":"null"}]},"event_slug":{"description":"A path segment of a Cal.com link, as it stands in it; set with `username`.","anyOf":[{"type":"string","minLength":1,"maxLength":100,"pattern":"^(?!\\.\\.?$)[A-Za-z0-9_.!~*'()-]+$"},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]},"host":{"anyOf":[{"type":"object","properties":{"title":{"description":"Trimmed and well formed, with no line break or control character; writing it clears `identity`.","anyOf":[{"type":"string","minLength":1,"maxLength":120,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},{"type":"null"}]},"subtitle":{"description":"Trimmed and well formed, with no line break or control character.","anyOf":[{"type":"string","minLength":1,"maxLength":150,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},{"type":"null"}]},"description":{"description":"Trimmed and well formed, line feeds and carriage returns allowed but no other control character.","anyOf":[{"type":"string","minLength":1,"maxLength":500,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u0009\\u000b\\u000c\\u000e-\\u001f\\u007f-\\u009f]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},{"type":"null"}]},"tags":{"description":"Each trimmed and well formed, with no comma, line break or control character; at most 250 characters joined one per line.","anyOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":250,"pattern":"^[^\\s,\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029,]*[^\\s,\\u0000-\\u001f\\u007f-\\u009f])?$"}},{"type":"null"}]},"identity":{"description":"Who the card names, its name read when shown; writing it clears `title`.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"member"},"user":{"description":"A user holding a seat on the store's business now.","type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"required":["kind","user"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"business"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"store"}},"required":["kind"],"additionalProperties":false},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["title","category"],"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}":{"get":{"operationId":"getProduct","summary":"Reads one product with its tiers and prices.","tags":["product"],"security":[{"bearer":["product:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Reads one product with its tiers and prices.","content":{"application/json":{"schema":{"type":"object","properties":{"holders":{"type":"number"},"seats":{"description":"An event's seats: what frozen carts hold and sales took, each ticket type's too; null for another category.","anyOf":[{"type":"object","properties":{"capacity":{"anyOf":[{"type":"number"},{"type":"null"}]},"held":{"type":"number"},"sold":{"type":"number"},"spots_left":{"anyOf":[{"type":"number"},{"type":"null"}]},"sold_out":{"type":"boolean"},"tickets":{"type":"array","items":{"type":"object","properties":{"tier_id":{"type":"string"},"capacity":{"anyOf":[{"type":"number"},{"type":"null"}]},"held":{"type":"number"},"sold":{"type":"number"},"spots_left":{"anyOf":[{"type":"number"},{"type":"null"}]},"sold_out":{"type":"boolean"}},"required":["tier_id","capacity","held","sold","spots_left","sold_out"]}}},"required":["capacity","held","sold","spots_left","sold_out","tickets"]},{"type":"null"}]},"poster":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"target":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"}},"required":["kind","id"]},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"from_body":{"type":"boolean"},"release_file":{"description":"A file a software release ships, which its release edits and the product's own list leaves out.","type":"boolean"},"position":{"type":"number"},"asset":{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}},"required":["id","target","role","delivery","preview_only","from_body","release_file","position","asset"]},{"type":"null"}]},"description":{"description":"The page's long description, in the rich text format as stored.","anyOf":[{"type":"string"},{"type":"null"}],"x-rich-text":"text"},"what_you_get":{"description":"What a buyer gets, in the rich text format as stored.","anyOf":[{"type":"string"},{"type":"null"}],"x-rich-text":"text"},"files":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["video","audio","image","pdf","file"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes, null when it has none or is withheld.","anyOf":[{"type":"number"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"description":"Seconds.","anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"url":{"description":"A public file's lasting URL, an image's naming its widths' version as `#v=` once they're made; null for a private one, or one whose bytes haven't landed.","anyOf":[{"type":"string"},{"type":"null"}]},"resized":{"description":"A public image's smaller copies, narrowest first, for a `srcset`; left out until they're made and its width measured, for one kept as uploaded, and for any other file.","type":"array","items":{"type":"object","properties":{"width":{"description":"Its width in pixels, at most the image's own.","type":"integer","minimum":1},"avif":{"description":"A lasting URL to it as AVIF.","type":"string"},"webp":{"description":"A lasting URL to it as WebP.","type":"string"}},"required":["width","avif","webp"]}},"attachment_id":{"description":"The binding a private file opens through; null when the reader can't open it.","anyOf":[{"type":"string"},{"type":"null"}]},"unlocks":{"description":"What unlocks a file its own rules keep from the reader, any one; null for any other file.","anyOf":[{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product_name":{"type":"string"},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]}},"required":["product_id","product_name","tier"]}},{"type":"null"}]},"video":{"description":"A video's subtitles and published AI outputs, where its read lists any and the reader may play it.","type":"object","properties":{"attachment_id":{"type":"string"},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["attachment_id","tracks","outputs"]},"audio":{"description":"An audio file's waveform, subtitles and published AI outputs, where the reader may play it.","type":"object","properties":{"waveform":{"description":"256 levels from 0 to 255, base64, from the file's start to its end; null until drawn, or when it can't be.","anyOf":[{"type":"string"},{"type":"null"}]},"attachment_id":{"description":"The binding its tracks and outputs open through, which a public file carries here alone; null with none.","anyOf":[{"type":"string"},{"type":"null"}]},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["waveform","attachment_id","tracks","outputs"]}},"required":["id","kind","mime","name","bytes","width","height","duration","pages","status","url","attachment_id","unlocks"]}},"tiers":{"type":"array","items":{"type":"object","properties":{"in_use":{"type":"object","properties":{"prices":{"type":"number"},"grants":{"type":"number"},"orders":{"type":"number"},"discounts":{"type":"number"},"gates":{"type":"number"}},"required":["prices","grants","orders","discounts","gates"]},"id":{"type":"string"},"product_id":{"type":"string"},"rank":{"type":"number"},"name":{"type":"string"},"settings":{"type":"object","properties":{"software":{"description":"A software tier: what its licenses unlock, answered by a license check.","type":"object","properties":{"features":{"description":"Distinct flags the seller's software reads: letters and digits, single hyphens, underscores, dots or colons between them.","type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9]+(?:[-_.:][A-Za-z0-9]+)*$"},"maxItems":100},"activation_limit":{"description":"The devices its licenses activate at once, over the product's default; none holds the product's.","type":"integer","minimum":1,"maximum":10000}}},"event":{"description":"An event's ticket type: how many guests it takes.","type":"object","properties":{"capacity":{"description":"How many guests this ticket type takes, within the event's own capacity; none means no limit of its own.","type":"integer","minimum":1,"maximum":1000000}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["in_use","id","product_id","rank","name","settings"]}},"prices":{"type":"array","items":{"type":"object","properties":{"in_use":{"type":"object","properties":{"orders":{"type":"number"},"subscriptions":{"type":"number"},"checkouts":{"type":"number"},"automations":{"type":"number"},"discounts":{"type":"number"}},"required":["orders","subscriptions","checkouts","automations","discounts"]},"id":{"type":"string"},"product_id":{"type":"string"},"tier_id":{"type":"string"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"type":"number"},"kind":{"type":"string","x-extensible-enum":["one_time","recurring"]},"period":{"anyOf":[{"type":"object","properties":{"unit":{"type":"string","x-extensible-enum":["day","week","month","year"]},"multiplier":{"type":"number"}},"required":["unit","multiplier"]},{"type":"null"}]},"highlighted":{"type":"boolean"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"autorenew":{"description":"Recurring only; false stops the renewal, absent renews.","type":"boolean"},"renewal_discount":{"description":"Recurring only, a percent off every renewal.","type":"integer","minimum":0,"maximum":100},"upgrade_multiplier":{"description":"One-time only, a factor on the difference paid to move up a tier.","type":"number","minimum":1,"maximum":10},"refund_policy":{"description":"Overrides the product's.","type":"string","x-extensible-enum":["none","24h","72h","7d","14d","30d"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["in_use","id","product_id","tier_id","currency","exponent","amount","kind","period","highlighted","title","description","settings","archived_at","created_at"]}},"in_use":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"count":{"type":"number"}},"required":["kind","count"]}},"delete_blocked_by":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"count":{"type":"number"}},"required":["kind","count"]}},"stats":{"type":"array","items":{"type":"object","properties":{"gross":{"anyOf":[{"type":"number"},{"type":"null"}]},"refunded":{"anyOf":[{"type":"number"},{"type":"null"}]},"platform_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"processor_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"affiliate_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"type":"string"},"settlement":{"type":"string","x-extensible-enum":["platform","seller","external"]},"transactions":{"type":"number"},"refunds":{"type":"number"},"buyers":{"type":"number"}},"required":["gross","refunded","platform_fee","processor_fee","affiliate_fee","exponent","currency","settlement","transactions","refunds","buyers"]}},"ratings":{"type":"object","properties":{"published":{"type":"object","properties":{"count":{"type":"number"},"average":{"anyOf":[{"type":"number"},{"type":"null"}]},"histogram":{"type":"object","properties":{"1":{"type":"number"},"2":{"type":"number"},"3":{"type":"number"},"4":{"type":"number"},"5":{"type":"number"}},"required":["1","2","3","4","5"]}},"required":["count","average","histogram"]},"live":{"type":"object","properties":{"hidden":{"type":"number"},"count":{"type":"number"},"average":{"anyOf":[{"type":"number"},{"type":"null"}]},"histogram":{"type":"object","properties":{"1":{"type":"number"},"2":{"type":"number"},"3":{"type":"number"},"4":{"type":"number"},"5":{"type":"number"}},"required":["1","2","3","4","5"]}},"required":["hidden","count","average","histogram"]}},"required":["published","live"]},"event_map":{"description":"An event's venue maps at its location's point, one image per theme; null until drawn, or for any other product.","anyOf":[{"type":"object","properties":{"light":{"description":"For a light page.","type":"object","properties":{"url":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"resized":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"width":{"type":"number"},"avif":{"type":"string"},"webp":{"type":"string"}},"required":["width","avif","webp"]}},{"type":"null"}]}},"required":["url","width","height","resized"]},"dark":{"description":"For a dark page.","type":"object","properties":{"url":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"resized":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"width":{"type":"number"},"avif":{"type":"string"},"webp":{"type":"string"}},"required":["width","avif","webp"]}},{"type":"null"}]}},"required":["url","width","height","resized"]},"attribution":{"description":"The credit shown over the map, linking `attribution_url`.","type":"string"},"attribution_url":{"type":"string"}},"required":["light","dark","attribution","attribution_url"]},{"type":"null"}]},"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The storefront path.","type":"string"},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"subtitle":{"description":"The short line shown under the title.","anyOf":[{"type":"string"},{"type":"null"}]},"category":{"type":"string"},"listing":{"type":"string","x-extensible-enum":["primary","secondary"]},"priority":{"type":"number"},"status":{"type":"string","x-extensible-enum":["draft","scheduled","published","discontinued"]},"unlisted":{"type":"boolean"},"feed_url":{"description":"The public feed's absolute URL, for a blog or a podcast that is published (discontinued too), listed and on a verified hostname; else null.","anyOf":[{"type":"string"},{"type":"null"}]},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"discontinued_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"unlisted_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"refund_policy":{"type":"string","x-extensible-enum":["none","24h","72h","7d","14d","30d"]},"progress_tracking":{"type":"string","x-extensible-enum":["manual","disabled","on_open","on_complete"]},"reviews_enabled":{"type":"boolean"},"review_summary_visible":{"description":"Whether customers see the generated review summary; it is written either way.","type":"boolean"},"purchase_note":{"description":"Shown beside the buy button.","type":"string","minLength":1,"maxLength":2000},"approval":{"description":"Whether each buyer waits as a pending request until the seller approves or declines it; none when unset.","type":"string","x-extensible-enum":["none","required"]},"approval_payment":{"description":"How a paid purchase waits for approval; saved_card when unset. Holds last about 7 days on a card.","type":"string","x-extensible-enum":["saved_card","hold"]},"calendar":{"description":"A bookable product: the seller's Cal.com event and the host card beside the widget; writes check it, reads answer it as stored.","type":"object","properties":{"calcom":{"type":"object","properties":{"username":{"type":"string"},"event_slug":{"type":"string"}}},"host":{"type":"object","properties":{"identity":{"description":"Set apart from `title`: a write of either clears the other.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"member"},"user":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["kind","user"]},{"type":"object","properties":{"kind":{"type":"string","const":"business"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"store"}},"required":["kind"]}]},"title":{"type":"string"},"subtitle":{"type":"string"},"description":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}}}},"coffee":{"description":"A tip button: what it is called and what it shows.","type":"object","properties":{"emoji":{"type":"string"},"descriptor":{"type":"string","minLength":3,"maxLength":15,"pattern":"^\\S(.*\\S)?$"}}},"software":{"description":"A software product: how its license keys start and how many devices each holds by default.","type":"object","properties":{"key_prefix":{"description":"Letters and digits, single hyphens or underscores between them.","type":"string","minLength":1,"maxLength":16,"pattern":"^[A-Za-z0-9]+(?:[-_][A-Za-z0-9]+)*$"},"activation_limit":{"description":"The devices a license activates at once by default; none means no limit.","type":"integer","minimum":1,"maximum":10000},"inactive_days":{"description":"Days after which a device the software stopped reporting no longer counts; none keeps it until freed.","type":"integer","minimum":1,"maximum":3650},"offline_days":{"description":"Days a signed license token lets the software run offline before it asks again; 30 when unset.","type":"integer","minimum":1,"maximum":365}}},"event":{"description":"An event product: how it is attended, where, and how it takes guests.","type":"object","properties":{"format":{"description":"In person, online or both; in person when unset.","type":"string","x-extensible-enum":["in_person","online","hybrid"]},"location":{"description":"Where an in-person event takes place.","type":"object","properties":{"venue":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":200,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"address":{"description":"The street address, trimmed, its lines apart and no other control character.","type":"string","minLength":1,"maxLength":500,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u0009\\u000b\\u000c\\u000e-\\u001f\\u007f-\\u009f]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"city":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":100,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"region":{"description":"A state, province or county. Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":100,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"postal_code":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":20,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"country":{"description":"ISO 3166-1 alpha-2, upper case.","type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Z]{2}$"},"latitude":{"description":"Where it is on a map, in decimal degrees, set together with `longitude`.","type":"number","minimum":-90,"maximum":90},"longitude":{"description":"Where it is on a map, in decimal degrees, set together with `latitude`.","type":"number","minimum":-180,"maximum":180},"map_url":{"description":"A map's page for the place. An https URL.","type":"string","minLength":1,"maxLength":2000,"pattern":"^https://"}}},"reveal_location":{"description":"Who sees the location: everyone, or ticket holders alone; everyone when unset.","type":"string","x-extensible-enum":["everyone","holders"]},"waitlist":{"description":"Whether guests may join a waitlist once it is full; not when unset.","type":"boolean"},"capacity":{"description":"How many guests it takes in all; none means no limit.","type":"integer","minimum":1,"maximum":1000000}}},"fundraising":{"description":"A fundraiser: the goal, in minor units of its currency.","type":"object","properties":{"goal":{"type":"integer","minimum":1},"currency":{"type":"string","minLength":3,"maxLength":3}},"required":["goal","currency"]},"feeds":{"description":"A blog's or a podcast's feeds: the public one always stays; `private` false turns every customer's private feed off.","type":"object","properties":{"private":{"type":"boolean"},"category":{"description":"A podcast's directory category, one of Apple's, its subcategory after ` > ` (`Arts > Books`).","type":"string","maxLength":64},"explicit":{"description":"Whether a podcast's episodes are explicit; not where unset.","type":"boolean"},"owner_email":{"description":"The address directories mail to verify a podcast's owner; never in a private feed.","type":"string","maxLength":254}}},"storefront":{"type":"object","properties":{"sales_counter":{"description":"A public count of orders on the product page.","type":"boolean"},"background_poster":{"description":"The poster doubles as the page background.","type":"boolean"},"require_dark":{"description":"The page renders dark whatever the visitor chose.","type":"boolean"}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["holders","seats","description","what_you_get","files","tiers","prices","in_use","delete_blocked_by","stats","ratings","event_map","id","slug","path","url","title","subtitle","category","listing","priority","status","unlisted","feed_url","published_at","discontinued_at","unlisted_at","created_at","updated_at","settings","metadata"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"patch":{"operationId":"updateProduct","summary":"Updates a product's fields.","tags":["product"],"security":[{"bearer":["product:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Updates a product's fields.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","x-extensible-enum":["draft","scheduled","published","discontinued"]},"category":{"type":"string"},"listing":{"type":"string","x-extensible-enum":["primary","secondary"]},"id":{"type":"string"},"slug":{"type":"string"},"title":{"type":"string"},"subtitle":{"description":"The short line shown under the title.","anyOf":[{"type":"string"},{"type":"null"}]},"priority":{"type":"number"},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"discontinued_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"unlisted_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"refund_policy":{"type":"string","x-extensible-enum":["none","24h","72h","7d","14d","30d"]},"progress_tracking":{"type":"string","x-extensible-enum":["manual","disabled","on_open","on_complete"]},"reviews_enabled":{"type":"boolean"},"review_summary_visible":{"description":"Whether customers see the generated review summary; it is written either way.","type":"boolean"},"purchase_note":{"description":"Shown beside the buy button.","type":"string","minLength":1,"maxLength":2000},"approval":{"description":"Whether each buyer waits as a pending request until the seller approves or declines it; none when unset.","type":"string","x-extensible-enum":["none","required"]},"approval_payment":{"description":"How a paid purchase waits for approval; saved_card when unset. Holds last about 7 days on a card.","type":"string","x-extensible-enum":["saved_card","hold"]},"calendar":{"description":"A bookable product: the seller's Cal.com event and the host card beside the widget; writes check it, reads answer it as stored.","type":"object","properties":{"calcom":{"type":"object","properties":{"username":{"type":"string"},"event_slug":{"type":"string"}}},"host":{"type":"object","properties":{"identity":{"description":"Set apart from `title`: a write of either clears the other.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"member"},"user":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["kind","user"]},{"type":"object","properties":{"kind":{"type":"string","const":"business"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"store"}},"required":["kind"]}]},"title":{"type":"string"},"subtitle":{"type":"string"},"description":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}}}},"coffee":{"description":"A tip button: what it is called and what it shows.","type":"object","properties":{"emoji":{"type":"string"},"descriptor":{"type":"string","minLength":3,"maxLength":15,"pattern":"^\\S(.*\\S)?$"}}},"software":{"description":"A software product: how its license keys start and how many devices each holds by default.","type":"object","properties":{"key_prefix":{"description":"Letters and digits, single hyphens or underscores between them.","type":"string","minLength":1,"maxLength":16,"pattern":"^[A-Za-z0-9]+(?:[-_][A-Za-z0-9]+)*$"},"activation_limit":{"description":"The devices a license activates at once by default; none means no limit.","type":"integer","minimum":1,"maximum":10000},"inactive_days":{"description":"Days after which a device the software stopped reporting no longer counts; none keeps it until freed.","type":"integer","minimum":1,"maximum":3650},"offline_days":{"description":"Days a signed license token lets the software run offline before it asks again; 30 when unset.","type":"integer","minimum":1,"maximum":365}}},"event":{"description":"An event product: how it is attended, where, and how it takes guests.","type":"object","properties":{"format":{"description":"In person, online or both; in person when unset.","type":"string","x-extensible-enum":["in_person","online","hybrid"]},"location":{"description":"Where an in-person event takes place.","type":"object","properties":{"venue":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":200,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"address":{"description":"The street address, trimmed, its lines apart and no other control character.","type":"string","minLength":1,"maxLength":500,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u0009\\u000b\\u000c\\u000e-\\u001f\\u007f-\\u009f]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"city":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":100,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"region":{"description":"A state, province or county. Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":100,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"postal_code":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":20,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"country":{"description":"ISO 3166-1 alpha-2, upper case.","type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Z]{2}$"},"latitude":{"description":"Where it is on a map, in decimal degrees, set together with `longitude`.","type":"number","minimum":-90,"maximum":90},"longitude":{"description":"Where it is on a map, in decimal degrees, set together with `latitude`.","type":"number","minimum":-180,"maximum":180},"map_url":{"description":"A map's page for the place. An https URL.","type":"string","minLength":1,"maxLength":2000,"pattern":"^https://"}}},"reveal_location":{"description":"Who sees the location: everyone, or ticket holders alone; everyone when unset.","type":"string","x-extensible-enum":["everyone","holders"]},"waitlist":{"description":"Whether guests may join a waitlist once it is full; not when unset.","type":"boolean"},"capacity":{"description":"How many guests it takes in all; none means no limit.","type":"integer","minimum":1,"maximum":1000000}}},"fundraising":{"description":"A fundraiser: the goal, in minor units of its currency.","type":"object","properties":{"goal":{"type":"integer","minimum":1},"currency":{"type":"string","minLength":3,"maxLength":3}},"required":["goal","currency"]},"feeds":{"description":"A blog's or a podcast's feeds: the public one always stays; `private` false turns every customer's private feed off.","type":"object","properties":{"private":{"type":"boolean"},"category":{"description":"A podcast's directory category, one of Apple's, its subcategory after ` > ` (`Arts > Books`).","type":"string","maxLength":64},"explicit":{"description":"Whether a podcast's episodes are explicit; not where unset.","type":"boolean"},"owner_email":{"description":"The address directories mail to verify a podcast's owner; never in a private feed.","type":"string","maxLength":254}}},"storefront":{"type":"object","properties":{"sales_counter":{"description":"A public count of orders on the product page.","type":"boolean"},"background_poster":{"description":"The poster doubles as the page background.","type":"boolean"},"require_dark":{"description":"The page renders dark whatever the visitor chose.","type":"boolean"}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"unlisted":{"type":"boolean"},"in_use":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"count":{"type":"number"}},"required":["kind","count"]}},"poster":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"target":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"}},"required":["kind","id"]},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"from_body":{"type":"boolean"},"release_file":{"description":"A file a software release ships, which its release edits and the product's own list leaves out.","type":"boolean"},"position":{"type":"number"},"asset":{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}},"required":["id","target","role","delivery","preview_only","from_body","release_file","position","asset"]},{"type":"null"}]},"path":{"description":"The storefront path.","type":"string"},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one.","anyOf":[{"type":"string"},{"type":"null"}]},"tiers":{"type":"array","items":{"type":"object","properties":{"in_use":{"type":"object","properties":{"prices":{"type":"number"},"grants":{"type":"number"},"orders":{"type":"number"},"discounts":{"type":"number"},"gates":{"type":"number"}},"required":["prices","grants","orders","discounts","gates"]},"id":{"type":"string"},"product_id":{"type":"string"},"rank":{"type":"number"},"name":{"type":"string"},"settings":{"type":"object","properties":{"software":{"description":"A software tier: what its licenses unlock, answered by a license check.","type":"object","properties":{"features":{"description":"Distinct flags the seller's software reads: letters and digits, single hyphens, underscores, dots or colons between them.","type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9]+(?:[-_.:][A-Za-z0-9]+)*$"},"maxItems":100},"activation_limit":{"description":"The devices its licenses activate at once, over the product's default; none holds the product's.","type":"integer","minimum":1,"maximum":10000}}},"event":{"description":"An event's ticket type: how many guests it takes.","type":"object","properties":{"capacity":{"description":"How many guests this ticket type takes, within the event's own capacity; none means no limit of its own.","type":"integer","minimum":1,"maximum":1000000}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["in_use","id","product_id","rank","name","settings"]}},"prices":{"type":"array","items":{"type":"object","properties":{"in_use":{"type":"object","properties":{"orders":{"type":"number"},"subscriptions":{"type":"number"},"checkouts":{"type":"number"},"automations":{"type":"number"},"discounts":{"type":"number"}},"required":["orders","subscriptions","checkouts","automations","discounts"]},"id":{"type":"string"},"product_id":{"type":"string"},"tier_id":{"type":"string"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"type":"number"},"kind":{"type":"string","x-extensible-enum":["one_time","recurring"]},"period":{"anyOf":[{"type":"object","properties":{"unit":{"type":"string","x-extensible-enum":["day","week","month","year"]},"multiplier":{"type":"number"}},"required":["unit","multiplier"]},{"type":"null"}]},"highlighted":{"type":"boolean"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"autorenew":{"description":"Recurring only; false stops the renewal, absent renews.","type":"boolean"},"renewal_discount":{"description":"Recurring only, a percent off every renewal.","type":"integer","minimum":0,"maximum":100},"upgrade_multiplier":{"description":"One-time only, a factor on the difference paid to move up a tier.","type":"number","minimum":1,"maximum":10},"refund_policy":{"description":"Overrides the product's.","type":"string","x-extensible-enum":["none","24h","72h","7d","14d","30d"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["in_use","id","product_id","tier_id","currency","exponent","amount","kind","period","highlighted","title","description","settings","archived_at","created_at"]}},"delete_blocked_by":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"count":{"type":"number"}},"required":["kind","count"]}},"stats":{"type":"array","items":{"type":"object","properties":{"gross":{"anyOf":[{"type":"number"},{"type":"null"}]},"refunded":{"anyOf":[{"type":"number"},{"type":"null"}]},"platform_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"processor_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"affiliate_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"type":"string"},"settlement":{"type":"string","x-extensible-enum":["platform","seller","external"]},"transactions":{"type":"number"},"refunds":{"type":"number"},"buyers":{"type":"number"}},"required":["gross","refunded","platform_fee","processor_fee","affiliate_fee","exponent","currency","settlement","transactions","refunds","buyers"]}},"ratings":{"type":"object","properties":{"published":{"type":"object","properties":{"count":{"type":"number"},"average":{"anyOf":[{"type":"number"},{"type":"null"}]},"histogram":{"type":"object","properties":{"1":{"type":"number"},"2":{"type":"number"},"3":{"type":"number"},"4":{"type":"number"},"5":{"type":"number"}},"required":["1","2","3","4","5"]}},"required":["count","average","histogram"]},"live":{"type":"object","properties":{"hidden":{"type":"number"},"count":{"type":"number"},"average":{"anyOf":[{"type":"number"},{"type":"null"}]},"histogram":{"type":"object","properties":{"1":{"type":"number"},"2":{"type":"number"},"3":{"type":"number"},"4":{"type":"number"},"5":{"type":"number"}},"required":["1","2","3","4","5"]}},"required":["hidden","count","average","histogram"]}},"required":["published","live"]},"event_map":{"description":"An event's venue maps at its location's point, one image per theme; null until drawn, or for any other product.","anyOf":[{"type":"object","properties":{"light":{"description":"For a light page.","type":"object","properties":{"url":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"resized":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"width":{"type":"number"},"avif":{"type":"string"},"webp":{"type":"string"}},"required":["width","avif","webp"]}},{"type":"null"}]}},"required":["url","width","height","resized"]},"dark":{"description":"For a dark page.","type":"object","properties":{"url":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"resized":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"width":{"type":"number"},"avif":{"type":"string"},"webp":{"type":"string"}},"required":["width","avif","webp"]}},{"type":"null"}]}},"required":["url","width","height","resized"]},"attribution":{"description":"The credit shown over the map, linking `attribution_url`.","type":"string"},"attribution_url":{"type":"string"}},"required":["light","dark","attribution","attribution_url"]},{"type":"null"}]},"feed_url":{"description":"The public feed's absolute URL, for a blog or a podcast that is published (discontinued too), listed and on a verified hostname; else null.","anyOf":[{"type":"string"},{"type":"null"}]},"description":{"description":"The page's long description, in the rich text format as stored; answered only with `full`.","anyOf":[{"type":"string"},{"type":"null"}],"x-rich-text":"text"},"what_you_get":{"description":"What a buyer gets, in the rich text format as stored; answered only with `full`.","anyOf":[{"type":"string"},{"type":"null"}],"x-rich-text":"text"},"files":{"description":"The files its prose names; answered only with `full`.","type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["video","audio","image","pdf","file"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes, null when it has none or is withheld.","anyOf":[{"type":"number"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"description":"Seconds.","anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"url":{"description":"A public file's lasting URL, an image's naming its widths' version as `#v=` once they're made; null for a private one, or one whose bytes haven't landed.","anyOf":[{"type":"string"},{"type":"null"}]},"resized":{"description":"A public image's smaller copies, narrowest first, for a `srcset`; left out until they're made and its width measured, for one kept as uploaded, and for any other file.","type":"array","items":{"type":"object","properties":{"width":{"description":"Its width in pixels, at most the image's own.","type":"integer","minimum":1},"avif":{"description":"A lasting URL to it as AVIF.","type":"string"},"webp":{"description":"A lasting URL to it as WebP.","type":"string"}},"required":["width","avif","webp"]}},"attachment_id":{"description":"The binding a private file opens through; null when the reader can't open it.","anyOf":[{"type":"string"},{"type":"null"}]},"unlocks":{"description":"What unlocks a file its own rules keep from the reader, any one; null for any other file.","anyOf":[{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product_name":{"type":"string"},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]}},"required":["product_id","product_name","tier"]}},{"type":"null"}]},"video":{"description":"A video's subtitles and published AI outputs, where its read lists any and the reader may play it.","type":"object","properties":{"attachment_id":{"type":"string"},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["attachment_id","tracks","outputs"]},"audio":{"description":"An audio file's waveform, subtitles and published AI outputs, where the reader may play it.","type":"object","properties":{"waveform":{"description":"256 levels from 0 to 255, base64, from the file's start to its end; null until drawn, or when it can't be.","anyOf":[{"type":"string"},{"type":"null"}]},"attachment_id":{"description":"The binding its tracks and outputs open through, which a public file carries here alone; null with none.","anyOf":[{"type":"string"},{"type":"null"}]},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["waveform","attachment_id","tracks","outputs"]}},"required":["id","kind","mime","name","bytes","width","height","duration","pages","status","url","attachment_id","unlocks"]}},"created":{"description":"The attachments the write bound: the files its new prose names.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string","x-extensible-enum":["prose","teaser","embed"]},"asset":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["id","role","asset"]}}},"required":["status","category","listing","id","slug","title","subtitle","priority","published_at","discontinued_at","unlisted_at","created_at","updated_at","settings","metadata","unlisted","in_use","path","url","tiers","prices","delete_blocked_by","stats","ratings","event_map","feed_url","created"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"text_format":{"type":"string","enum":["html","markdown"],"default":"html","description":"The format the rich text fields are written in: the rich text format’s HTML, or Markdown converted into it before it is validated. A text already stored in the format (starting with `<rich-text`) is kept as it is either way."},"listing":{"type":"string","enum":["primary","secondary"]},"title":{"type":"string","minLength":1,"maxLength":200},"subtitle":{"description":"The short line shown under the title.","anyOf":[{"type":"string","minLength":1,"maxLength":100},{"type":"null"}]},"description":{"description":"The page's long description, a rich text (images, videos, audio, slideshows, formulas and diagrams only as blocks, an image it starts showing at most 15 MB) stored in its canonical form.","anyOf":[{"type":"string","minLength":1,"maxLength":100000},{"type":"null"}],"x-rich-text":"text"},"what_you_get":{"description":"What a buyer gets, a rich text (images, videos, audio, slideshows, formulas and diagrams only as blocks, an image it starts showing at most 15 MB) stored in its canonical form.","anyOf":[{"type":"string","minLength":1,"maxLength":100000},{"type":"null"}],"x-rich-text":"text"},"priority":{"type":"integer","minimum":0,"maximum":1000000},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true},"settings":{"description":"Merged onto the stored settings; null deletes a key.","type":"object","properties":{"feeds":{"description":"A blog's or a podcast's feeds: the public one always stays; `private` false turns every customer's private feed off.","anyOf":[{"type":"object","properties":{"private":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"category":{"description":"A podcast's directory category, one of Apple's, its subcategory after ` > ` (`Arts > Books`).","anyOf":[{"type":"string","maxLength":64},{"type":"null"}]},"explicit":{"description":"Whether a podcast's episodes are explicit; not where unset.","anyOf":[{"type":"boolean"},{"type":"null"}]},"owner_email":{"description":"The address directories mail to verify a podcast's owner; never in a private feed.","anyOf":[{"type":"string","maxLength":254},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]},"event":{"description":"An event product: how it is attended, where, and how it takes guests.","anyOf":[{"type":"object","properties":{"format":{"description":"In person, online or both; in person when unset.","anyOf":[{"type":"string","enum":["in_person","online","hybrid"]},{"type":"null"}]},"location":{"description":"Where an in-person event takes place.","anyOf":[{"type":"object","properties":{"venue":{"description":"Trimmed, with no line break or control character.","anyOf":[{"type":"string","minLength":1,"maxLength":200,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},{"type":"null"}]},"address":{"description":"The street address, trimmed, its lines apart and no other control character.","anyOf":[{"type":"string","minLength":1,"maxLength":500,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u0009\\u000b\\u000c\\u000e-\\u001f\\u007f-\\u009f]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},{"type":"null"}]},"city":{"description":"Trimmed, with no line break or control character.","anyOf":[{"type":"string","minLength":1,"maxLength":100,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},{"type":"null"}]},"region":{"description":"A state, province or county. Trimmed, with no line break or control character.","anyOf":[{"type":"string","minLength":1,"maxLength":100,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},{"type":"null"}]},"postal_code":{"description":"Trimmed, with no line break or control character.","anyOf":[{"type":"string","minLength":1,"maxLength":20,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},{"type":"null"}]},"country":{"description":"ISO 3166-1 alpha-2, upper case.","anyOf":[{"type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Z]{2}$"},{"type":"null"}]},"latitude":{"description":"Where it is on a map, in decimal degrees, set together with `longitude`.","anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"description":"Where it is on a map, in decimal degrees, set together with `latitude`.","anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"map_url":{"description":"A map's page for the place. An https URL.","anyOf":[{"type":"string","minLength":1,"maxLength":2000,"pattern":"^https://"},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]},"reveal_location":{"description":"Who sees the location: everyone, or ticket holders alone; everyone when unset.","anyOf":[{"type":"string","enum":["everyone","holders"]},{"type":"null"}]},"waitlist":{"description":"Whether guests may join a waitlist once it is full; not when unset.","anyOf":[{"type":"boolean"},{"type":"null"}]},"capacity":{"description":"How many guests it takes in all; none means no limit.","anyOf":[{"type":"integer","minimum":1,"maximum":1000000},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]},"refund_policy":{"anyOf":[{"type":"string","enum":["none","24h","72h","7d","14d","30d"]},{"type":"null"}]},"progress_tracking":{"anyOf":[{"type":"string","enum":["manual","disabled","on_open","on_complete"]},{"type":"null"}]},"reviews_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"review_summary_visible":{"description":"Whether customers see the generated review summary; it is written either way.","anyOf":[{"type":"boolean"},{"type":"null"}]},"purchase_note":{"description":"Shown beside the buy button.","anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]},"approval":{"description":"Whether each buyer waits as a pending request until the seller approves or declines it; none when unset.","anyOf":[{"type":"string","enum":["none","required"]},{"type":"null"}]},"approval_payment":{"description":"How a paid purchase waits for approval; saved_card when unset. Holds last about 7 days on a card.","anyOf":[{"type":"string","enum":["saved_card","hold"]},{"type":"null"}]},"coffee":{"description":"A tip button: what it is called and what it shows.","anyOf":[{"type":"object","properties":{"emoji":{"anyOf":[{"type":"string"},{"type":"null"}]},"descriptor":{"anyOf":[{"type":"string","minLength":3,"maxLength":15,"pattern":"^\\S(.*\\S)?$"},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]},"software":{"description":"A software product: how its license keys start and how many devices each holds by default.","anyOf":[{"type":"object","properties":{"key_prefix":{"description":"Letters and digits, single hyphens or underscores between them.","anyOf":[{"type":"string","minLength":1,"maxLength":16,"pattern":"^[A-Za-z0-9]+(?:[-_][A-Za-z0-9]+)*$"},{"type":"null"}]},"activation_limit":{"description":"The devices a license activates at once by default; none means no limit.","anyOf":[{"type":"integer","minimum":1,"maximum":10000},{"type":"null"}]},"inactive_days":{"description":"Days after which a device the software stopped reporting no longer counts; none keeps it until freed.","anyOf":[{"type":"integer","minimum":1,"maximum":3650},{"type":"null"}]},"offline_days":{"description":"Days a signed license token lets the software run offline before it asks again; 30 when unset.","anyOf":[{"type":"integer","minimum":1,"maximum":365},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]},"fundraising":{"description":"A fundraiser: the goal, in minor units of its currency.","anyOf":[{"type":"object","properties":{"goal":{"type":"integer","minimum":1},"currency":{"type":"string","minLength":3,"maxLength":3}},"additionalProperties":false},{"type":"null"}]},"storefront":{"anyOf":[{"type":"object","properties":{"sales_counter":{"description":"A public count of orders on the product page.","anyOf":[{"type":"boolean"},{"type":"null"}]},"background_poster":{"description":"The poster doubles as the page background.","anyOf":[{"type":"boolean"},{"type":"null"}]},"require_dark":{"description":"The page renders dark whatever the visitor chose.","anyOf":[{"type":"boolean"},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]},"calendar":{"description":"A bookable product: the seller's Cal.com event and the host card beside the widget.","anyOf":[{"type":"object","properties":{"calcom":{"anyOf":[{"type":"object","properties":{"username":{"description":"A path segment of a Cal.com link, as it stands in it; set with `event_slug`.","anyOf":[{"type":"string","minLength":1,"maxLength":100,"pattern":"^(?!\\.\\.?$)[A-Za-z0-9_.!~*'()-]+$"},{"type":"null"}]},"event_slug":{"description":"A path segment of a Cal.com link, as it stands in it; set with `username`.","anyOf":[{"type":"string","minLength":1,"maxLength":100,"pattern":"^(?!\\.\\.?$)[A-Za-z0-9_.!~*'()-]+$"},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]},"host":{"anyOf":[{"type":"object","properties":{"title":{"description":"Trimmed and well formed, with no line break or control character; writing it clears `identity`.","anyOf":[{"type":"string","minLength":1,"maxLength":120,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},{"type":"null"}]},"subtitle":{"description":"Trimmed and well formed, with no line break or control character.","anyOf":[{"type":"string","minLength":1,"maxLength":150,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},{"type":"null"}]},"description":{"description":"Trimmed and well formed, line feeds and carriage returns allowed but no other control character.","anyOf":[{"type":"string","minLength":1,"maxLength":500,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u0009\\u000b\\u000c\\u000e-\\u001f\\u007f-\\u009f]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},{"type":"null"}]},"tags":{"description":"Each trimmed and well formed, with no comma, line break or control character; at most 250 characters joined one per line.","anyOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":250,"pattern":"^[^\\s,\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029,]*[^\\s,\\u0000-\\u001f\\u007f-\\u009f])?$"}},{"type":"null"}]},"identity":{"description":"Who the card names, its name read when shown; writing it clears `title`.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"member"},"user":{"description":"A user holding a seat on the store's business now.","type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"required":["kind","user"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"business"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"store"}},"required":["kind"],"additionalProperties":false},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"object","properties":{"calcom":{"anyOf":[{"type":"object","properties":{"username":{"description":"A path segment of a Cal.com link, as it stands in it; set with `event_slug`.","anyOf":[{"type":"string","minLength":1,"maxLength":100,"pattern":"^(?!\\.\\.?$)[A-Za-z0-9_.!~*'()-]+$"},{"type":"null"}]},"event_slug":{"description":"A path segment of a Cal.com link, as it stands in it; set with `username`.","anyOf":[{"type":"string","minLength":1,"maxLength":100,"pattern":"^(?!\\.\\.?$)[A-Za-z0-9_.!~*'()-]+$"},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]},"host":{"anyOf":[{"type":"object","properties":{"title":{"description":"Trimmed and well formed, with no line break or control character; writing it clears `identity`.","anyOf":[{"type":"string","minLength":1,"maxLength":120,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},{"type":"null"}]},"subtitle":{"description":"Trimmed and well formed, with no line break or control character.","anyOf":[{"type":"string","minLength":1,"maxLength":150,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},{"type":"null"}]},"description":{"description":"Trimmed and well formed, line feeds and carriage returns allowed but no other control character.","anyOf":[{"type":"string","minLength":1,"maxLength":500,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u0009\\u000b\\u000c\\u000e-\\u001f\\u007f-\\u009f]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},{"type":"null"}]},"tags":{"description":"Each trimmed and well formed, with no comma, line break or control character; at most 250 characters joined one per line.","anyOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":250,"pattern":"^[^\\s,\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029,]*[^\\s,\\u0000-\\u001f\\u007f-\\u009f])?$"}},{"type":"null"}]},"identity":{"description":"Who the card names, its name read when shown; writing it clears `title`.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"member"},"user":{"description":"A user holding a seat on the store's business now.","type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"required":["kind","user"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"business"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"store"}},"required":["kind"],"additionalProperties":false},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]}}},"additionalProperties":false}}}}},"delete":{"operationId":"deleteProduct","summary":"Deletes a product no order, grant or subscription refers to.","tags":["product"],"security":[{"bearer":["product:delete"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Deletes a product no order, grant or subscription refers to.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean","const":true}},"required":["id","deleted"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/summaries":{"get":{"operationId":"productSummaries","summary":"Reads the short summaries of up to a page of products by id, with where each stands.","tags":["product"],"security":[{"bearer":["product:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"ids","in":"query","required":true,"explode":true,"schema":{"type":"array","items":{"type":"string","minLength":1,"maxLength":512},"minItems":1,"maxItems":100}}],"responses":{"200":{"description":"Reads the short summaries of up to a page of products by id, with where each stands.","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"},"status":{"description":"Where the product stands at the read; it says nothing of one `deleted`.","type":"string","x-extensible-enum":["draft","scheduled","published","discontinued"]}},"required":["id","slug","path","url","title","category","deleted","status"]}}},"required":["items"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/publish":{"post":{"operationId":"publishProduct","summary":"Publishes a product now or schedules it.","tags":["product"],"security":[{"bearer":["product:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Publishes a product now or schedules it.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","x-extensible-enum":["draft","scheduled","published","discontinued"]},"category":{"type":"string"},"listing":{"type":"string","x-extensible-enum":["primary","secondary"]},"id":{"type":"string"},"slug":{"type":"string"},"title":{"type":"string"},"subtitle":{"description":"The short line shown under the title.","anyOf":[{"type":"string"},{"type":"null"}]},"priority":{"type":"number"},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"discontinued_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"unlisted_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"refund_policy":{"type":"string","x-extensible-enum":["none","24h","72h","7d","14d","30d"]},"progress_tracking":{"type":"string","x-extensible-enum":["manual","disabled","on_open","on_complete"]},"reviews_enabled":{"type":"boolean"},"review_summary_visible":{"description":"Whether customers see the generated review summary; it is written either way.","type":"boolean"},"purchase_note":{"description":"Shown beside the buy button.","type":"string","minLength":1,"maxLength":2000},"approval":{"description":"Whether each buyer waits as a pending request until the seller approves or declines it; none when unset.","type":"string","x-extensible-enum":["none","required"]},"approval_payment":{"description":"How a paid purchase waits for approval; saved_card when unset. Holds last about 7 days on a card.","type":"string","x-extensible-enum":["saved_card","hold"]},"calendar":{"description":"A bookable product: the seller's Cal.com event and the host card beside the widget; writes check it, reads answer it as stored.","type":"object","properties":{"calcom":{"type":"object","properties":{"username":{"type":"string"},"event_slug":{"type":"string"}}},"host":{"type":"object","properties":{"identity":{"description":"Set apart from `title`: a write of either clears the other.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"member"},"user":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["kind","user"]},{"type":"object","properties":{"kind":{"type":"string","const":"business"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"store"}},"required":["kind"]}]},"title":{"type":"string"},"subtitle":{"type":"string"},"description":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}}}},"coffee":{"description":"A tip button: what it is called and what it shows.","type":"object","properties":{"emoji":{"type":"string"},"descriptor":{"type":"string","minLength":3,"maxLength":15,"pattern":"^\\S(.*\\S)?$"}}},"software":{"description":"A software product: how its license keys start and how many devices each holds by default.","type":"object","properties":{"key_prefix":{"description":"Letters and digits, single hyphens or underscores between them.","type":"string","minLength":1,"maxLength":16,"pattern":"^[A-Za-z0-9]+(?:[-_][A-Za-z0-9]+)*$"},"activation_limit":{"description":"The devices a license activates at once by default; none means no limit.","type":"integer","minimum":1,"maximum":10000},"inactive_days":{"description":"Days after which a device the software stopped reporting no longer counts; none keeps it until freed.","type":"integer","minimum":1,"maximum":3650},"offline_days":{"description":"Days a signed license token lets the software run offline before it asks again; 30 when unset.","type":"integer","minimum":1,"maximum":365}}},"event":{"description":"An event product: how it is attended, where, and how it takes guests.","type":"object","properties":{"format":{"description":"In person, online or both; in person when unset.","type":"string","x-extensible-enum":["in_person","online","hybrid"]},"location":{"description":"Where an in-person event takes place.","type":"object","properties":{"venue":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":200,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"address":{"description":"The street address, trimmed, its lines apart and no other control character.","type":"string","minLength":1,"maxLength":500,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u0009\\u000b\\u000c\\u000e-\\u001f\\u007f-\\u009f]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"city":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":100,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"region":{"description":"A state, province or county. Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":100,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"postal_code":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":20,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"country":{"description":"ISO 3166-1 alpha-2, upper case.","type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Z]{2}$"},"latitude":{"description":"Where it is on a map, in decimal degrees, set together with `longitude`.","type":"number","minimum":-90,"maximum":90},"longitude":{"description":"Where it is on a map, in decimal degrees, set together with `latitude`.","type":"number","minimum":-180,"maximum":180},"map_url":{"description":"A map's page for the place. An https URL.","type":"string","minLength":1,"maxLength":2000,"pattern":"^https://"}}},"reveal_location":{"description":"Who sees the location: everyone, or ticket holders alone; everyone when unset.","type":"string","x-extensible-enum":["everyone","holders"]},"waitlist":{"description":"Whether guests may join a waitlist once it is full; not when unset.","type":"boolean"},"capacity":{"description":"How many guests it takes in all; none means no limit.","type":"integer","minimum":1,"maximum":1000000}}},"fundraising":{"description":"A fundraiser: the goal, in minor units of its currency.","type":"object","properties":{"goal":{"type":"integer","minimum":1},"currency":{"type":"string","minLength":3,"maxLength":3}},"required":["goal","currency"]},"feeds":{"description":"A blog's or a podcast's feeds: the public one always stays; `private` false turns every customer's private feed off.","type":"object","properties":{"private":{"type":"boolean"},"category":{"description":"A podcast's directory category, one of Apple's, its subcategory after ` > ` (`Arts > Books`).","type":"string","maxLength":64},"explicit":{"description":"Whether a podcast's episodes are explicit; not where unset.","type":"boolean"},"owner_email":{"description":"The address directories mail to verify a podcast's owner; never in a private feed.","type":"string","maxLength":254}}},"storefront":{"type":"object","properties":{"sales_counter":{"description":"A public count of orders on the product page.","type":"boolean"},"background_poster":{"description":"The poster doubles as the page background.","type":"boolean"},"require_dark":{"description":"The page renders dark whatever the visitor chose.","type":"boolean"}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"unlisted":{"type":"boolean"},"in_use":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"count":{"type":"number"}},"required":["kind","count"]}},"poster":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"target":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"}},"required":["kind","id"]},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"from_body":{"type":"boolean"},"release_file":{"description":"A file a software release ships, which its release edits and the product's own list leaves out.","type":"boolean"},"position":{"type":"number"},"asset":{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}},"required":["id","target","role","delivery","preview_only","from_body","release_file","position","asset"]},{"type":"null"}]},"path":{"description":"The storefront path.","type":"string"},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one.","anyOf":[{"type":"string"},{"type":"null"}]},"tiers":{"type":"array","items":{"type":"object","properties":{"in_use":{"type":"object","properties":{"prices":{"type":"number"},"grants":{"type":"number"},"orders":{"type":"number"},"discounts":{"type":"number"},"gates":{"type":"number"}},"required":["prices","grants","orders","discounts","gates"]},"id":{"type":"string"},"product_id":{"type":"string"},"rank":{"type":"number"},"name":{"type":"string"},"settings":{"type":"object","properties":{"software":{"description":"A software tier: what its licenses unlock, answered by a license check.","type":"object","properties":{"features":{"description":"Distinct flags the seller's software reads: letters and digits, single hyphens, underscores, dots or colons between them.","type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9]+(?:[-_.:][A-Za-z0-9]+)*$"},"maxItems":100},"activation_limit":{"description":"The devices its licenses activate at once, over the product's default; none holds the product's.","type":"integer","minimum":1,"maximum":10000}}},"event":{"description":"An event's ticket type: how many guests it takes.","type":"object","properties":{"capacity":{"description":"How many guests this ticket type takes, within the event's own capacity; none means no limit of its own.","type":"integer","minimum":1,"maximum":1000000}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["in_use","id","product_id","rank","name","settings"]}},"prices":{"type":"array","items":{"type":"object","properties":{"in_use":{"type":"object","properties":{"orders":{"type":"number"},"subscriptions":{"type":"number"},"checkouts":{"type":"number"},"automations":{"type":"number"},"discounts":{"type":"number"}},"required":["orders","subscriptions","checkouts","automations","discounts"]},"id":{"type":"string"},"product_id":{"type":"string"},"tier_id":{"type":"string"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"type":"number"},"kind":{"type":"string","x-extensible-enum":["one_time","recurring"]},"period":{"anyOf":[{"type":"object","properties":{"unit":{"type":"string","x-extensible-enum":["day","week","month","year"]},"multiplier":{"type":"number"}},"required":["unit","multiplier"]},{"type":"null"}]},"highlighted":{"type":"boolean"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"autorenew":{"description":"Recurring only; false stops the renewal, absent renews.","type":"boolean"},"renewal_discount":{"description":"Recurring only, a percent off every renewal.","type":"integer","minimum":0,"maximum":100},"upgrade_multiplier":{"description":"One-time only, a factor on the difference paid to move up a tier.","type":"number","minimum":1,"maximum":10},"refund_policy":{"description":"Overrides the product's.","type":"string","x-extensible-enum":["none","24h","72h","7d","14d","30d"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["in_use","id","product_id","tier_id","currency","exponent","amount","kind","period","highlighted","title","description","settings","archived_at","created_at"]}},"delete_blocked_by":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"count":{"type":"number"}},"required":["kind","count"]}},"stats":{"type":"array","items":{"type":"object","properties":{"gross":{"anyOf":[{"type":"number"},{"type":"null"}]},"refunded":{"anyOf":[{"type":"number"},{"type":"null"}]},"platform_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"processor_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"affiliate_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"type":"string"},"settlement":{"type":"string","x-extensible-enum":["platform","seller","external"]},"transactions":{"type":"number"},"refunds":{"type":"number"},"buyers":{"type":"number"}},"required":["gross","refunded","platform_fee","processor_fee","affiliate_fee","exponent","currency","settlement","transactions","refunds","buyers"]}},"ratings":{"type":"object","properties":{"published":{"type":"object","properties":{"count":{"type":"number"},"average":{"anyOf":[{"type":"number"},{"type":"null"}]},"histogram":{"type":"object","properties":{"1":{"type":"number"},"2":{"type":"number"},"3":{"type":"number"},"4":{"type":"number"},"5":{"type":"number"}},"required":["1","2","3","4","5"]}},"required":["count","average","histogram"]},"live":{"type":"object","properties":{"hidden":{"type":"number"},"count":{"type":"number"},"average":{"anyOf":[{"type":"number"},{"type":"null"}]},"histogram":{"type":"object","properties":{"1":{"type":"number"},"2":{"type":"number"},"3":{"type":"number"},"4":{"type":"number"},"5":{"type":"number"}},"required":["1","2","3","4","5"]}},"required":["hidden","count","average","histogram"]}},"required":["published","live"]},"event_map":{"description":"An event's venue maps at its location's point, one image per theme; null until drawn, or for any other product.","anyOf":[{"type":"object","properties":{"light":{"description":"For a light page.","type":"object","properties":{"url":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"resized":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"width":{"type":"number"},"avif":{"type":"string"},"webp":{"type":"string"}},"required":["width","avif","webp"]}},{"type":"null"}]}},"required":["url","width","height","resized"]},"dark":{"description":"For a dark page.","type":"object","properties":{"url":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"resized":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"width":{"type":"number"},"avif":{"type":"string"},"webp":{"type":"string"}},"required":["width","avif","webp"]}},{"type":"null"}]}},"required":["url","width","height","resized"]},"attribution":{"description":"The credit shown over the map, linking `attribution_url`.","type":"string"},"attribution_url":{"type":"string"}},"required":["light","dark","attribution","attribution_url"]},{"type":"null"}]},"feed_url":{"description":"The public feed's absolute URL, for a blog or a podcast that is published (discontinued too), listed and on a verified hostname; else null.","anyOf":[{"type":"string"},{"type":"null"}]},"description":{"description":"The page's long description, in the rich text format as stored; answered only with `full`.","anyOf":[{"type":"string"},{"type":"null"}],"x-rich-text":"text"},"what_you_get":{"description":"What a buyer gets, in the rich text format as stored; answered only with `full`.","anyOf":[{"type":"string"},{"type":"null"}],"x-rich-text":"text"},"files":{"description":"The files its prose names; answered only with `full`.","type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["video","audio","image","pdf","file"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes, null when it has none or is withheld.","anyOf":[{"type":"number"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"description":"Seconds.","anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"url":{"description":"A public file's lasting URL, an image's naming its widths' version as `#v=` once they're made; null for a private one, or one whose bytes haven't landed.","anyOf":[{"type":"string"},{"type":"null"}]},"resized":{"description":"A public image's smaller copies, narrowest first, for a `srcset`; left out until they're made and its width measured, for one kept as uploaded, and for any other file.","type":"array","items":{"type":"object","properties":{"width":{"description":"Its width in pixels, at most the image's own.","type":"integer","minimum":1},"avif":{"description":"A lasting URL to it as AVIF.","type":"string"},"webp":{"description":"A lasting URL to it as WebP.","type":"string"}},"required":["width","avif","webp"]}},"attachment_id":{"description":"The binding a private file opens through; null when the reader can't open it.","anyOf":[{"type":"string"},{"type":"null"}]},"unlocks":{"description":"What unlocks a file its own rules keep from the reader, any one; null for any other file.","anyOf":[{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product_name":{"type":"string"},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]}},"required":["product_id","product_name","tier"]}},{"type":"null"}]},"video":{"description":"A video's subtitles and published AI outputs, where its read lists any and the reader may play it.","type":"object","properties":{"attachment_id":{"type":"string"},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["attachment_id","tracks","outputs"]},"audio":{"description":"An audio file's waveform, subtitles and published AI outputs, where the reader may play it.","type":"object","properties":{"waveform":{"description":"256 levels from 0 to 255, base64, from the file's start to its end; null until drawn, or when it can't be.","anyOf":[{"type":"string"},{"type":"null"}]},"attachment_id":{"description":"The binding its tracks and outputs open through, which a public file carries here alone; null with none.","anyOf":[{"type":"string"},{"type":"null"}]},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["waveform","attachment_id","tracks","outputs"]}},"required":["id","kind","mime","name","bytes","width","height","duration","pages","status","url","attachment_id","unlocks"]}},"created":{"description":"The attachments the write bound: the files its new prose names.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string","x-extensible-enum":["prose","teaser","embed"]},"asset":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["id","role","asset"]}}},"required":["status","category","listing","id","slug","title","subtitle","priority","published_at","discontinued_at","unlisted_at","created_at","updated_at","settings","metadata","unlisted","in_use","path","url","tiers","prices","delete_blocked_by","stats","ratings","event_map","feed_url","created"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true},"at":{"type":"string","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})(?:T(\\d{2}):(\\d{2})(?::(\\d{2})(?:\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"}},"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/unpublish":{"post":{"operationId":"unpublishProduct","summary":"Takes a product back to draft.","tags":["product"],"security":[{"bearer":["product:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Takes a product back to draft.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","x-extensible-enum":["draft","scheduled","published","discontinued"]},"category":{"type":"string"},"listing":{"type":"string","x-extensible-enum":["primary","secondary"]},"id":{"type":"string"},"slug":{"type":"string"},"title":{"type":"string"},"subtitle":{"description":"The short line shown under the title.","anyOf":[{"type":"string"},{"type":"null"}]},"priority":{"type":"number"},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"discontinued_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"unlisted_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"refund_policy":{"type":"string","x-extensible-enum":["none","24h","72h","7d","14d","30d"]},"progress_tracking":{"type":"string","x-extensible-enum":["manual","disabled","on_open","on_complete"]},"reviews_enabled":{"type":"boolean"},"review_summary_visible":{"description":"Whether customers see the generated review summary; it is written either way.","type":"boolean"},"purchase_note":{"description":"Shown beside the buy button.","type":"string","minLength":1,"maxLength":2000},"approval":{"description":"Whether each buyer waits as a pending request until the seller approves or declines it; none when unset.","type":"string","x-extensible-enum":["none","required"]},"approval_payment":{"description":"How a paid purchase waits for approval; saved_card when unset. Holds last about 7 days on a card.","type":"string","x-extensible-enum":["saved_card","hold"]},"calendar":{"description":"A bookable product: the seller's Cal.com event and the host card beside the widget; writes check it, reads answer it as stored.","type":"object","properties":{"calcom":{"type":"object","properties":{"username":{"type":"string"},"event_slug":{"type":"string"}}},"host":{"type":"object","properties":{"identity":{"description":"Set apart from `title`: a write of either clears the other.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"member"},"user":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["kind","user"]},{"type":"object","properties":{"kind":{"type":"string","const":"business"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"store"}},"required":["kind"]}]},"title":{"type":"string"},"subtitle":{"type":"string"},"description":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}}}},"coffee":{"description":"A tip button: what it is called and what it shows.","type":"object","properties":{"emoji":{"type":"string"},"descriptor":{"type":"string","minLength":3,"maxLength":15,"pattern":"^\\S(.*\\S)?$"}}},"software":{"description":"A software product: how its license keys start and how many devices each holds by default.","type":"object","properties":{"key_prefix":{"description":"Letters and digits, single hyphens or underscores between them.","type":"string","minLength":1,"maxLength":16,"pattern":"^[A-Za-z0-9]+(?:[-_][A-Za-z0-9]+)*$"},"activation_limit":{"description":"The devices a license activates at once by default; none means no limit.","type":"integer","minimum":1,"maximum":10000},"inactive_days":{"description":"Days after which a device the software stopped reporting no longer counts; none keeps it until freed.","type":"integer","minimum":1,"maximum":3650},"offline_days":{"description":"Days a signed license token lets the software run offline before it asks again; 30 when unset.","type":"integer","minimum":1,"maximum":365}}},"event":{"description":"An event product: how it is attended, where, and how it takes guests.","type":"object","properties":{"format":{"description":"In person, online or both; in person when unset.","type":"string","x-extensible-enum":["in_person","online","hybrid"]},"location":{"description":"Where an in-person event takes place.","type":"object","properties":{"venue":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":200,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"address":{"description":"The street address, trimmed, its lines apart and no other control character.","type":"string","minLength":1,"maxLength":500,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u0009\\u000b\\u000c\\u000e-\\u001f\\u007f-\\u009f]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"city":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":100,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"region":{"description":"A state, province or county. Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":100,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"postal_code":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":20,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"country":{"description":"ISO 3166-1 alpha-2, upper case.","type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Z]{2}$"},"latitude":{"description":"Where it is on a map, in decimal degrees, set together with `longitude`.","type":"number","minimum":-90,"maximum":90},"longitude":{"description":"Where it is on a map, in decimal degrees, set together with `latitude`.","type":"number","minimum":-180,"maximum":180},"map_url":{"description":"A map's page for the place. An https URL.","type":"string","minLength":1,"maxLength":2000,"pattern":"^https://"}}},"reveal_location":{"description":"Who sees the location: everyone, or ticket holders alone; everyone when unset.","type":"string","x-extensible-enum":["everyone","holders"]},"waitlist":{"description":"Whether guests may join a waitlist once it is full; not when unset.","type":"boolean"},"capacity":{"description":"How many guests it takes in all; none means no limit.","type":"integer","minimum":1,"maximum":1000000}}},"fundraising":{"description":"A fundraiser: the goal, in minor units of its currency.","type":"object","properties":{"goal":{"type":"integer","minimum":1},"currency":{"type":"string","minLength":3,"maxLength":3}},"required":["goal","currency"]},"feeds":{"description":"A blog's or a podcast's feeds: the public one always stays; `private` false turns every customer's private feed off.","type":"object","properties":{"private":{"type":"boolean"},"category":{"description":"A podcast's directory category, one of Apple's, its subcategory after ` > ` (`Arts > Books`).","type":"string","maxLength":64},"explicit":{"description":"Whether a podcast's episodes are explicit; not where unset.","type":"boolean"},"owner_email":{"description":"The address directories mail to verify a podcast's owner; never in a private feed.","type":"string","maxLength":254}}},"storefront":{"type":"object","properties":{"sales_counter":{"description":"A public count of orders on the product page.","type":"boolean"},"background_poster":{"description":"The poster doubles as the page background.","type":"boolean"},"require_dark":{"description":"The page renders dark whatever the visitor chose.","type":"boolean"}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"unlisted":{"type":"boolean"},"in_use":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"count":{"type":"number"}},"required":["kind","count"]}},"poster":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"target":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"}},"required":["kind","id"]},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"from_body":{"type":"boolean"},"release_file":{"description":"A file a software release ships, which its release edits and the product's own list leaves out.","type":"boolean"},"position":{"type":"number"},"asset":{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}},"required":["id","target","role","delivery","preview_only","from_body","release_file","position","asset"]},{"type":"null"}]},"path":{"description":"The storefront path.","type":"string"},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one.","anyOf":[{"type":"string"},{"type":"null"}]},"tiers":{"type":"array","items":{"type":"object","properties":{"in_use":{"type":"object","properties":{"prices":{"type":"number"},"grants":{"type":"number"},"orders":{"type":"number"},"discounts":{"type":"number"},"gates":{"type":"number"}},"required":["prices","grants","orders","discounts","gates"]},"id":{"type":"string"},"product_id":{"type":"string"},"rank":{"type":"number"},"name":{"type":"string"},"settings":{"type":"object","properties":{"software":{"description":"A software tier: what its licenses unlock, answered by a license check.","type":"object","properties":{"features":{"description":"Distinct flags the seller's software reads: letters and digits, single hyphens, underscores, dots or colons between them.","type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9]+(?:[-_.:][A-Za-z0-9]+)*$"},"maxItems":100},"activation_limit":{"description":"The devices its licenses activate at once, over the product's default; none holds the product's.","type":"integer","minimum":1,"maximum":10000}}},"event":{"description":"An event's ticket type: how many guests it takes.","type":"object","properties":{"capacity":{"description":"How many guests this ticket type takes, within the event's own capacity; none means no limit of its own.","type":"integer","minimum":1,"maximum":1000000}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["in_use","id","product_id","rank","name","settings"]}},"prices":{"type":"array","items":{"type":"object","properties":{"in_use":{"type":"object","properties":{"orders":{"type":"number"},"subscriptions":{"type":"number"},"checkouts":{"type":"number"},"automations":{"type":"number"},"discounts":{"type":"number"}},"required":["orders","subscriptions","checkouts","automations","discounts"]},"id":{"type":"string"},"product_id":{"type":"string"},"tier_id":{"type":"string"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"type":"number"},"kind":{"type":"string","x-extensible-enum":["one_time","recurring"]},"period":{"anyOf":[{"type":"object","properties":{"unit":{"type":"string","x-extensible-enum":["day","week","month","year"]},"multiplier":{"type":"number"}},"required":["unit","multiplier"]},{"type":"null"}]},"highlighted":{"type":"boolean"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"autorenew":{"description":"Recurring only; false stops the renewal, absent renews.","type":"boolean"},"renewal_discount":{"description":"Recurring only, a percent off every renewal.","type":"integer","minimum":0,"maximum":100},"upgrade_multiplier":{"description":"One-time only, a factor on the difference paid to move up a tier.","type":"number","minimum":1,"maximum":10},"refund_policy":{"description":"Overrides the product's.","type":"string","x-extensible-enum":["none","24h","72h","7d","14d","30d"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["in_use","id","product_id","tier_id","currency","exponent","amount","kind","period","highlighted","title","description","settings","archived_at","created_at"]}},"delete_blocked_by":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"count":{"type":"number"}},"required":["kind","count"]}},"stats":{"type":"array","items":{"type":"object","properties":{"gross":{"anyOf":[{"type":"number"},{"type":"null"}]},"refunded":{"anyOf":[{"type":"number"},{"type":"null"}]},"platform_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"processor_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"affiliate_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"type":"string"},"settlement":{"type":"string","x-extensible-enum":["platform","seller","external"]},"transactions":{"type":"number"},"refunds":{"type":"number"},"buyers":{"type":"number"}},"required":["gross","refunded","platform_fee","processor_fee","affiliate_fee","exponent","currency","settlement","transactions","refunds","buyers"]}},"ratings":{"type":"object","properties":{"published":{"type":"object","properties":{"count":{"type":"number"},"average":{"anyOf":[{"type":"number"},{"type":"null"}]},"histogram":{"type":"object","properties":{"1":{"type":"number"},"2":{"type":"number"},"3":{"type":"number"},"4":{"type":"number"},"5":{"type":"number"}},"required":["1","2","3","4","5"]}},"required":["count","average","histogram"]},"live":{"type":"object","properties":{"hidden":{"type":"number"},"count":{"type":"number"},"average":{"anyOf":[{"type":"number"},{"type":"null"}]},"histogram":{"type":"object","properties":{"1":{"type":"number"},"2":{"type":"number"},"3":{"type":"number"},"4":{"type":"number"},"5":{"type":"number"}},"required":["1","2","3","4","5"]}},"required":["hidden","count","average","histogram"]}},"required":["published","live"]},"event_map":{"description":"An event's venue maps at its location's point, one image per theme; null until drawn, or for any other product.","anyOf":[{"type":"object","properties":{"light":{"description":"For a light page.","type":"object","properties":{"url":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"resized":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"width":{"type":"number"},"avif":{"type":"string"},"webp":{"type":"string"}},"required":["width","avif","webp"]}},{"type":"null"}]}},"required":["url","width","height","resized"]},"dark":{"description":"For a dark page.","type":"object","properties":{"url":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"resized":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"width":{"type":"number"},"avif":{"type":"string"},"webp":{"type":"string"}},"required":["width","avif","webp"]}},{"type":"null"}]}},"required":["url","width","height","resized"]},"attribution":{"description":"The credit shown over the map, linking `attribution_url`.","type":"string"},"attribution_url":{"type":"string"}},"required":["light","dark","attribution","attribution_url"]},{"type":"null"}]},"feed_url":{"description":"The public feed's absolute URL, for a blog or a podcast that is published (discontinued too), listed and on a verified hostname; else null.","anyOf":[{"type":"string"},{"type":"null"}]},"description":{"description":"The page's long description, in the rich text format as stored; answered only with `full`.","anyOf":[{"type":"string"},{"type":"null"}],"x-rich-text":"text"},"what_you_get":{"description":"What a buyer gets, in the rich text format as stored; answered only with `full`.","anyOf":[{"type":"string"},{"type":"null"}],"x-rich-text":"text"},"files":{"description":"The files its prose names; answered only with `full`.","type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["video","audio","image","pdf","file"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes, null when it has none or is withheld.","anyOf":[{"type":"number"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"description":"Seconds.","anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"url":{"description":"A public file's lasting URL, an image's naming its widths' version as `#v=` once they're made; null for a private one, or one whose bytes haven't landed.","anyOf":[{"type":"string"},{"type":"null"}]},"resized":{"description":"A public image's smaller copies, narrowest first, for a `srcset`; left out until they're made and its width measured, for one kept as uploaded, and for any other file.","type":"array","items":{"type":"object","properties":{"width":{"description":"Its width in pixels, at most the image's own.","type":"integer","minimum":1},"avif":{"description":"A lasting URL to it as AVIF.","type":"string"},"webp":{"description":"A lasting URL to it as WebP.","type":"string"}},"required":["width","avif","webp"]}},"attachment_id":{"description":"The binding a private file opens through; null when the reader can't open it.","anyOf":[{"type":"string"},{"type":"null"}]},"unlocks":{"description":"What unlocks a file its own rules keep from the reader, any one; null for any other file.","anyOf":[{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product_name":{"type":"string"},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]}},"required":["product_id","product_name","tier"]}},{"type":"null"}]},"video":{"description":"A video's subtitles and published AI outputs, where its read lists any and the reader may play it.","type":"object","properties":{"attachment_id":{"type":"string"},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["attachment_id","tracks","outputs"]},"audio":{"description":"An audio file's waveform, subtitles and published AI outputs, where the reader may play it.","type":"object","properties":{"waveform":{"description":"256 levels from 0 to 255, base64, from the file's start to its end; null until drawn, or when it can't be.","anyOf":[{"type":"string"},{"type":"null"}]},"attachment_id":{"description":"The binding its tracks and outputs open through, which a public file carries here alone; null with none.","anyOf":[{"type":"string"},{"type":"null"}]},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["waveform","attachment_id","tracks","outputs"]}},"required":["id","kind","mime","name","bytes","width","height","duration","pages","status","url","attachment_id","unlocks"]}},"created":{"description":"The attachments the write bound: the files its new prose names.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string","x-extensible-enum":["prose","teaser","embed"]},"asset":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["id","role","asset"]}}},"required":["status","category","listing","id","slug","title","subtitle","priority","published_at","discontinued_at","unlisted_at","created_at","updated_at","settings","metadata","unlisted","in_use","path","url","tiers","prices","delete_blocked_by","stats","ratings","event_map","feed_url","created"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true}},"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/discontinue":{"post":{"operationId":"discontinueProduct","summary":"Stops selling a product while keeping it for its holders.","tags":["product"],"security":[{"bearer":["product:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Stops selling a product while keeping it for its holders.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","x-extensible-enum":["draft","scheduled","published","discontinued"]},"category":{"type":"string"},"listing":{"type":"string","x-extensible-enum":["primary","secondary"]},"id":{"type":"string"},"slug":{"type":"string"},"title":{"type":"string"},"subtitle":{"description":"The short line shown under the title.","anyOf":[{"type":"string"},{"type":"null"}]},"priority":{"type":"number"},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"discontinued_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"unlisted_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"refund_policy":{"type":"string","x-extensible-enum":["none","24h","72h","7d","14d","30d"]},"progress_tracking":{"type":"string","x-extensible-enum":["manual","disabled","on_open","on_complete"]},"reviews_enabled":{"type":"boolean"},"review_summary_visible":{"description":"Whether customers see the generated review summary; it is written either way.","type":"boolean"},"purchase_note":{"description":"Shown beside the buy button.","type":"string","minLength":1,"maxLength":2000},"approval":{"description":"Whether each buyer waits as a pending request until the seller approves or declines it; none when unset.","type":"string","x-extensible-enum":["none","required"]},"approval_payment":{"description":"How a paid purchase waits for approval; saved_card when unset. Holds last about 7 days on a card.","type":"string","x-extensible-enum":["saved_card","hold"]},"calendar":{"description":"A bookable product: the seller's Cal.com event and the host card beside the widget; writes check it, reads answer it as stored.","type":"object","properties":{"calcom":{"type":"object","properties":{"username":{"type":"string"},"event_slug":{"type":"string"}}},"host":{"type":"object","properties":{"identity":{"description":"Set apart from `title`: a write of either clears the other.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"member"},"user":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["kind","user"]},{"type":"object","properties":{"kind":{"type":"string","const":"business"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"store"}},"required":["kind"]}]},"title":{"type":"string"},"subtitle":{"type":"string"},"description":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}}}},"coffee":{"description":"A tip button: what it is called and what it shows.","type":"object","properties":{"emoji":{"type":"string"},"descriptor":{"type":"string","minLength":3,"maxLength":15,"pattern":"^\\S(.*\\S)?$"}}},"software":{"description":"A software product: how its license keys start and how many devices each holds by default.","type":"object","properties":{"key_prefix":{"description":"Letters and digits, single hyphens or underscores between them.","type":"string","minLength":1,"maxLength":16,"pattern":"^[A-Za-z0-9]+(?:[-_][A-Za-z0-9]+)*$"},"activation_limit":{"description":"The devices a license activates at once by default; none means no limit.","type":"integer","minimum":1,"maximum":10000},"inactive_days":{"description":"Days after which a device the software stopped reporting no longer counts; none keeps it until freed.","type":"integer","minimum":1,"maximum":3650},"offline_days":{"description":"Days a signed license token lets the software run offline before it asks again; 30 when unset.","type":"integer","minimum":1,"maximum":365}}},"event":{"description":"An event product: how it is attended, where, and how it takes guests.","type":"object","properties":{"format":{"description":"In person, online or both; in person when unset.","type":"string","x-extensible-enum":["in_person","online","hybrid"]},"location":{"description":"Where an in-person event takes place.","type":"object","properties":{"venue":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":200,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"address":{"description":"The street address, trimmed, its lines apart and no other control character.","type":"string","minLength":1,"maxLength":500,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u0009\\u000b\\u000c\\u000e-\\u001f\\u007f-\\u009f]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"city":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":100,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"region":{"description":"A state, province or county. Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":100,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"postal_code":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":20,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"country":{"description":"ISO 3166-1 alpha-2, upper case.","type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Z]{2}$"},"latitude":{"description":"Where it is on a map, in decimal degrees, set together with `longitude`.","type":"number","minimum":-90,"maximum":90},"longitude":{"description":"Where it is on a map, in decimal degrees, set together with `latitude`.","type":"number","minimum":-180,"maximum":180},"map_url":{"description":"A map's page for the place. An https URL.","type":"string","minLength":1,"maxLength":2000,"pattern":"^https://"}}},"reveal_location":{"description":"Who sees the location: everyone, or ticket holders alone; everyone when unset.","type":"string","x-extensible-enum":["everyone","holders"]},"waitlist":{"description":"Whether guests may join a waitlist once it is full; not when unset.","type":"boolean"},"capacity":{"description":"How many guests it takes in all; none means no limit.","type":"integer","minimum":1,"maximum":1000000}}},"fundraising":{"description":"A fundraiser: the goal, in minor units of its currency.","type":"object","properties":{"goal":{"type":"integer","minimum":1},"currency":{"type":"string","minLength":3,"maxLength":3}},"required":["goal","currency"]},"feeds":{"description":"A blog's or a podcast's feeds: the public one always stays; `private` false turns every customer's private feed off.","type":"object","properties":{"private":{"type":"boolean"},"category":{"description":"A podcast's directory category, one of Apple's, its subcategory after ` > ` (`Arts > Books`).","type":"string","maxLength":64},"explicit":{"description":"Whether a podcast's episodes are explicit; not where unset.","type":"boolean"},"owner_email":{"description":"The address directories mail to verify a podcast's owner; never in a private feed.","type":"string","maxLength":254}}},"storefront":{"type":"object","properties":{"sales_counter":{"description":"A public count of orders on the product page.","type":"boolean"},"background_poster":{"description":"The poster doubles as the page background.","type":"boolean"},"require_dark":{"description":"The page renders dark whatever the visitor chose.","type":"boolean"}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"unlisted":{"type":"boolean"},"in_use":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"count":{"type":"number"}},"required":["kind","count"]}},"poster":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"target":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"}},"required":["kind","id"]},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"from_body":{"type":"boolean"},"release_file":{"description":"A file a software release ships, which its release edits and the product's own list leaves out.","type":"boolean"},"position":{"type":"number"},"asset":{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}},"required":["id","target","role","delivery","preview_only","from_body","release_file","position","asset"]},{"type":"null"}]},"path":{"description":"The storefront path.","type":"string"},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one.","anyOf":[{"type":"string"},{"type":"null"}]},"tiers":{"type":"array","items":{"type":"object","properties":{"in_use":{"type":"object","properties":{"prices":{"type":"number"},"grants":{"type":"number"},"orders":{"type":"number"},"discounts":{"type":"number"},"gates":{"type":"number"}},"required":["prices","grants","orders","discounts","gates"]},"id":{"type":"string"},"product_id":{"type":"string"},"rank":{"type":"number"},"name":{"type":"string"},"settings":{"type":"object","properties":{"software":{"description":"A software tier: what its licenses unlock, answered by a license check.","type":"object","properties":{"features":{"description":"Distinct flags the seller's software reads: letters and digits, single hyphens, underscores, dots or colons between them.","type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9]+(?:[-_.:][A-Za-z0-9]+)*$"},"maxItems":100},"activation_limit":{"description":"The devices its licenses activate at once, over the product's default; none holds the product's.","type":"integer","minimum":1,"maximum":10000}}},"event":{"description":"An event's ticket type: how many guests it takes.","type":"object","properties":{"capacity":{"description":"How many guests this ticket type takes, within the event's own capacity; none means no limit of its own.","type":"integer","minimum":1,"maximum":1000000}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["in_use","id","product_id","rank","name","settings"]}},"prices":{"type":"array","items":{"type":"object","properties":{"in_use":{"type":"object","properties":{"orders":{"type":"number"},"subscriptions":{"type":"number"},"checkouts":{"type":"number"},"automations":{"type":"number"},"discounts":{"type":"number"}},"required":["orders","subscriptions","checkouts","automations","discounts"]},"id":{"type":"string"},"product_id":{"type":"string"},"tier_id":{"type":"string"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"type":"number"},"kind":{"type":"string","x-extensible-enum":["one_time","recurring"]},"period":{"anyOf":[{"type":"object","properties":{"unit":{"type":"string","x-extensible-enum":["day","week","month","year"]},"multiplier":{"type":"number"}},"required":["unit","multiplier"]},{"type":"null"}]},"highlighted":{"type":"boolean"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"autorenew":{"description":"Recurring only; false stops the renewal, absent renews.","type":"boolean"},"renewal_discount":{"description":"Recurring only, a percent off every renewal.","type":"integer","minimum":0,"maximum":100},"upgrade_multiplier":{"description":"One-time only, a factor on the difference paid to move up a tier.","type":"number","minimum":1,"maximum":10},"refund_policy":{"description":"Overrides the product's.","type":"string","x-extensible-enum":["none","24h","72h","7d","14d","30d"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["in_use","id","product_id","tier_id","currency","exponent","amount","kind","period","highlighted","title","description","settings","archived_at","created_at"]}},"delete_blocked_by":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"count":{"type":"number"}},"required":["kind","count"]}},"stats":{"type":"array","items":{"type":"object","properties":{"gross":{"anyOf":[{"type":"number"},{"type":"null"}]},"refunded":{"anyOf":[{"type":"number"},{"type":"null"}]},"platform_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"processor_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"affiliate_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"type":"string"},"settlement":{"type":"string","x-extensible-enum":["platform","seller","external"]},"transactions":{"type":"number"},"refunds":{"type":"number"},"buyers":{"type":"number"}},"required":["gross","refunded","platform_fee","processor_fee","affiliate_fee","exponent","currency","settlement","transactions","refunds","buyers"]}},"ratings":{"type":"object","properties":{"published":{"type":"object","properties":{"count":{"type":"number"},"average":{"anyOf":[{"type":"number"},{"type":"null"}]},"histogram":{"type":"object","properties":{"1":{"type":"number"},"2":{"type":"number"},"3":{"type":"number"},"4":{"type":"number"},"5":{"type":"number"}},"required":["1","2","3","4","5"]}},"required":["count","average","histogram"]},"live":{"type":"object","properties":{"hidden":{"type":"number"},"count":{"type":"number"},"average":{"anyOf":[{"type":"number"},{"type":"null"}]},"histogram":{"type":"object","properties":{"1":{"type":"number"},"2":{"type":"number"},"3":{"type":"number"},"4":{"type":"number"},"5":{"type":"number"}},"required":["1","2","3","4","5"]}},"required":["hidden","count","average","histogram"]}},"required":["published","live"]},"event_map":{"description":"An event's venue maps at its location's point, one image per theme; null until drawn, or for any other product.","anyOf":[{"type":"object","properties":{"light":{"description":"For a light page.","type":"object","properties":{"url":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"resized":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"width":{"type":"number"},"avif":{"type":"string"},"webp":{"type":"string"}},"required":["width","avif","webp"]}},{"type":"null"}]}},"required":["url","width","height","resized"]},"dark":{"description":"For a dark page.","type":"object","properties":{"url":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"resized":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"width":{"type":"number"},"avif":{"type":"string"},"webp":{"type":"string"}},"required":["width","avif","webp"]}},{"type":"null"}]}},"required":["url","width","height","resized"]},"attribution":{"description":"The credit shown over the map, linking `attribution_url`.","type":"string"},"attribution_url":{"type":"string"}},"required":["light","dark","attribution","attribution_url"]},{"type":"null"}]},"feed_url":{"description":"The public feed's absolute URL, for a blog or a podcast that is published (discontinued too), listed and on a verified hostname; else null.","anyOf":[{"type":"string"},{"type":"null"}]},"description":{"description":"The page's long description, in the rich text format as stored; answered only with `full`.","anyOf":[{"type":"string"},{"type":"null"}],"x-rich-text":"text"},"what_you_get":{"description":"What a buyer gets, in the rich text format as stored; answered only with `full`.","anyOf":[{"type":"string"},{"type":"null"}],"x-rich-text":"text"},"files":{"description":"The files its prose names; answered only with `full`.","type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["video","audio","image","pdf","file"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes, null when it has none or is withheld.","anyOf":[{"type":"number"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"description":"Seconds.","anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"url":{"description":"A public file's lasting URL, an image's naming its widths' version as `#v=` once they're made; null for a private one, or one whose bytes haven't landed.","anyOf":[{"type":"string"},{"type":"null"}]},"resized":{"description":"A public image's smaller copies, narrowest first, for a `srcset`; left out until they're made and its width measured, for one kept as uploaded, and for any other file.","type":"array","items":{"type":"object","properties":{"width":{"description":"Its width in pixels, at most the image's own.","type":"integer","minimum":1},"avif":{"description":"A lasting URL to it as AVIF.","type":"string"},"webp":{"description":"A lasting URL to it as WebP.","type":"string"}},"required":["width","avif","webp"]}},"attachment_id":{"description":"The binding a private file opens through; null when the reader can't open it.","anyOf":[{"type":"string"},{"type":"null"}]},"unlocks":{"description":"What unlocks a file its own rules keep from the reader, any one; null for any other file.","anyOf":[{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product_name":{"type":"string"},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]}},"required":["product_id","product_name","tier"]}},{"type":"null"}]},"video":{"description":"A video's subtitles and published AI outputs, where its read lists any and the reader may play it.","type":"object","properties":{"attachment_id":{"type":"string"},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["attachment_id","tracks","outputs"]},"audio":{"description":"An audio file's waveform, subtitles and published AI outputs, where the reader may play it.","type":"object","properties":{"waveform":{"description":"256 levels from 0 to 255, base64, from the file's start to its end; null until drawn, or when it can't be.","anyOf":[{"type":"string"},{"type":"null"}]},"attachment_id":{"description":"The binding its tracks and outputs open through, which a public file carries here alone; null with none.","anyOf":[{"type":"string"},{"type":"null"}]},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["waveform","attachment_id","tracks","outputs"]}},"required":["id","kind","mime","name","bytes","width","height","duration","pages","status","url","attachment_id","unlocks"]}},"created":{"description":"The attachments the write bound: the files its new prose names.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string","x-extensible-enum":["prose","teaser","embed"]},"asset":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["id","role","asset"]}}},"required":["status","category","listing","id","slug","title","subtitle","priority","published_at","discontinued_at","unlisted_at","created_at","updated_at","settings","metadata","unlisted","in_use","path","url","tiers","prices","delete_blocked_by","stats","ratings","event_map","feed_url","created"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true}},"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/reinstate":{"post":{"operationId":"reinstateProduct","summary":"Sells a discontinued product again.","tags":["product"],"security":[{"bearer":["product:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Sells a discontinued product again.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","x-extensible-enum":["draft","scheduled","published","discontinued"]},"category":{"type":"string"},"listing":{"type":"string","x-extensible-enum":["primary","secondary"]},"id":{"type":"string"},"slug":{"type":"string"},"title":{"type":"string"},"subtitle":{"description":"The short line shown under the title.","anyOf":[{"type":"string"},{"type":"null"}]},"priority":{"type":"number"},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"discontinued_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"unlisted_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"refund_policy":{"type":"string","x-extensible-enum":["none","24h","72h","7d","14d","30d"]},"progress_tracking":{"type":"string","x-extensible-enum":["manual","disabled","on_open","on_complete"]},"reviews_enabled":{"type":"boolean"},"review_summary_visible":{"description":"Whether customers see the generated review summary; it is written either way.","type":"boolean"},"purchase_note":{"description":"Shown beside the buy button.","type":"string","minLength":1,"maxLength":2000},"approval":{"description":"Whether each buyer waits as a pending request until the seller approves or declines it; none when unset.","type":"string","x-extensible-enum":["none","required"]},"approval_payment":{"description":"How a paid purchase waits for approval; saved_card when unset. Holds last about 7 days on a card.","type":"string","x-extensible-enum":["saved_card","hold"]},"calendar":{"description":"A bookable product: the seller's Cal.com event and the host card beside the widget; writes check it, reads answer it as stored.","type":"object","properties":{"calcom":{"type":"object","properties":{"username":{"type":"string"},"event_slug":{"type":"string"}}},"host":{"type":"object","properties":{"identity":{"description":"Set apart from `title`: a write of either clears the other.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"member"},"user":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["kind","user"]},{"type":"object","properties":{"kind":{"type":"string","const":"business"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"store"}},"required":["kind"]}]},"title":{"type":"string"},"subtitle":{"type":"string"},"description":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}}}},"coffee":{"description":"A tip button: what it is called and what it shows.","type":"object","properties":{"emoji":{"type":"string"},"descriptor":{"type":"string","minLength":3,"maxLength":15,"pattern":"^\\S(.*\\S)?$"}}},"software":{"description":"A software product: how its license keys start and how many devices each holds by default.","type":"object","properties":{"key_prefix":{"description":"Letters and digits, single hyphens or underscores between them.","type":"string","minLength":1,"maxLength":16,"pattern":"^[A-Za-z0-9]+(?:[-_][A-Za-z0-9]+)*$"},"activation_limit":{"description":"The devices a license activates at once by default; none means no limit.","type":"integer","minimum":1,"maximum":10000},"inactive_days":{"description":"Days after which a device the software stopped reporting no longer counts; none keeps it until freed.","type":"integer","minimum":1,"maximum":3650},"offline_days":{"description":"Days a signed license token lets the software run offline before it asks again; 30 when unset.","type":"integer","minimum":1,"maximum":365}}},"event":{"description":"An event product: how it is attended, where, and how it takes guests.","type":"object","properties":{"format":{"description":"In person, online or both; in person when unset.","type":"string","x-extensible-enum":["in_person","online","hybrid"]},"location":{"description":"Where an in-person event takes place.","type":"object","properties":{"venue":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":200,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"address":{"description":"The street address, trimmed, its lines apart and no other control character.","type":"string","minLength":1,"maxLength":500,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u0009\\u000b\\u000c\\u000e-\\u001f\\u007f-\\u009f]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"city":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":100,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"region":{"description":"A state, province or county. Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":100,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"postal_code":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":20,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"country":{"description":"ISO 3166-1 alpha-2, upper case.","type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Z]{2}$"},"latitude":{"description":"Where it is on a map, in decimal degrees, set together with `longitude`.","type":"number","minimum":-90,"maximum":90},"longitude":{"description":"Where it is on a map, in decimal degrees, set together with `latitude`.","type":"number","minimum":-180,"maximum":180},"map_url":{"description":"A map's page for the place. An https URL.","type":"string","minLength":1,"maxLength":2000,"pattern":"^https://"}}},"reveal_location":{"description":"Who sees the location: everyone, or ticket holders alone; everyone when unset.","type":"string","x-extensible-enum":["everyone","holders"]},"waitlist":{"description":"Whether guests may join a waitlist once it is full; not when unset.","type":"boolean"},"capacity":{"description":"How many guests it takes in all; none means no limit.","type":"integer","minimum":1,"maximum":1000000}}},"fundraising":{"description":"A fundraiser: the goal, in minor units of its currency.","type":"object","properties":{"goal":{"type":"integer","minimum":1},"currency":{"type":"string","minLength":3,"maxLength":3}},"required":["goal","currency"]},"feeds":{"description":"A blog's or a podcast's feeds: the public one always stays; `private` false turns every customer's private feed off.","type":"object","properties":{"private":{"type":"boolean"},"category":{"description":"A podcast's directory category, one of Apple's, its subcategory after ` > ` (`Arts > Books`).","type":"string","maxLength":64},"explicit":{"description":"Whether a podcast's episodes are explicit; not where unset.","type":"boolean"},"owner_email":{"description":"The address directories mail to verify a podcast's owner; never in a private feed.","type":"string","maxLength":254}}},"storefront":{"type":"object","properties":{"sales_counter":{"description":"A public count of orders on the product page.","type":"boolean"},"background_poster":{"description":"The poster doubles as the page background.","type":"boolean"},"require_dark":{"description":"The page renders dark whatever the visitor chose.","type":"boolean"}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"unlisted":{"type":"boolean"},"in_use":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"count":{"type":"number"}},"required":["kind","count"]}},"poster":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"target":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"}},"required":["kind","id"]},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"from_body":{"type":"boolean"},"release_file":{"description":"A file a software release ships, which its release edits and the product's own list leaves out.","type":"boolean"},"position":{"type":"number"},"asset":{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}},"required":["id","target","role","delivery","preview_only","from_body","release_file","position","asset"]},{"type":"null"}]},"path":{"description":"The storefront path.","type":"string"},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one.","anyOf":[{"type":"string"},{"type":"null"}]},"tiers":{"type":"array","items":{"type":"object","properties":{"in_use":{"type":"object","properties":{"prices":{"type":"number"},"grants":{"type":"number"},"orders":{"type":"number"},"discounts":{"type":"number"},"gates":{"type":"number"}},"required":["prices","grants","orders","discounts","gates"]},"id":{"type":"string"},"product_id":{"type":"string"},"rank":{"type":"number"},"name":{"type":"string"},"settings":{"type":"object","properties":{"software":{"description":"A software tier: what its licenses unlock, answered by a license check.","type":"object","properties":{"features":{"description":"Distinct flags the seller's software reads: letters and digits, single hyphens, underscores, dots or colons between them.","type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9]+(?:[-_.:][A-Za-z0-9]+)*$"},"maxItems":100},"activation_limit":{"description":"The devices its licenses activate at once, over the product's default; none holds the product's.","type":"integer","minimum":1,"maximum":10000}}},"event":{"description":"An event's ticket type: how many guests it takes.","type":"object","properties":{"capacity":{"description":"How many guests this ticket type takes, within the event's own capacity; none means no limit of its own.","type":"integer","minimum":1,"maximum":1000000}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["in_use","id","product_id","rank","name","settings"]}},"prices":{"type":"array","items":{"type":"object","properties":{"in_use":{"type":"object","properties":{"orders":{"type":"number"},"subscriptions":{"type":"number"},"checkouts":{"type":"number"},"automations":{"type":"number"},"discounts":{"type":"number"}},"required":["orders","subscriptions","checkouts","automations","discounts"]},"id":{"type":"string"},"product_id":{"type":"string"},"tier_id":{"type":"string"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"type":"number"},"kind":{"type":"string","x-extensible-enum":["one_time","recurring"]},"period":{"anyOf":[{"type":"object","properties":{"unit":{"type":"string","x-extensible-enum":["day","week","month","year"]},"multiplier":{"type":"number"}},"required":["unit","multiplier"]},{"type":"null"}]},"highlighted":{"type":"boolean"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"autorenew":{"description":"Recurring only; false stops the renewal, absent renews.","type":"boolean"},"renewal_discount":{"description":"Recurring only, a percent off every renewal.","type":"integer","minimum":0,"maximum":100},"upgrade_multiplier":{"description":"One-time only, a factor on the difference paid to move up a tier.","type":"number","minimum":1,"maximum":10},"refund_policy":{"description":"Overrides the product's.","type":"string","x-extensible-enum":["none","24h","72h","7d","14d","30d"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["in_use","id","product_id","tier_id","currency","exponent","amount","kind","period","highlighted","title","description","settings","archived_at","created_at"]}},"delete_blocked_by":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"count":{"type":"number"}},"required":["kind","count"]}},"stats":{"type":"array","items":{"type":"object","properties":{"gross":{"anyOf":[{"type":"number"},{"type":"null"}]},"refunded":{"anyOf":[{"type":"number"},{"type":"null"}]},"platform_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"processor_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"affiliate_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"type":"string"},"settlement":{"type":"string","x-extensible-enum":["platform","seller","external"]},"transactions":{"type":"number"},"refunds":{"type":"number"},"buyers":{"type":"number"}},"required":["gross","refunded","platform_fee","processor_fee","affiliate_fee","exponent","currency","settlement","transactions","refunds","buyers"]}},"ratings":{"type":"object","properties":{"published":{"type":"object","properties":{"count":{"type":"number"},"average":{"anyOf":[{"type":"number"},{"type":"null"}]},"histogram":{"type":"object","properties":{"1":{"type":"number"},"2":{"type":"number"},"3":{"type":"number"},"4":{"type":"number"},"5":{"type":"number"}},"required":["1","2","3","4","5"]}},"required":["count","average","histogram"]},"live":{"type":"object","properties":{"hidden":{"type":"number"},"count":{"type":"number"},"average":{"anyOf":[{"type":"number"},{"type":"null"}]},"histogram":{"type":"object","properties":{"1":{"type":"number"},"2":{"type":"number"},"3":{"type":"number"},"4":{"type":"number"},"5":{"type":"number"}},"required":["1","2","3","4","5"]}},"required":["hidden","count","average","histogram"]}},"required":["published","live"]},"event_map":{"description":"An event's venue maps at its location's point, one image per theme; null until drawn, or for any other product.","anyOf":[{"type":"object","properties":{"light":{"description":"For a light page.","type":"object","properties":{"url":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"resized":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"width":{"type":"number"},"avif":{"type":"string"},"webp":{"type":"string"}},"required":["width","avif","webp"]}},{"type":"null"}]}},"required":["url","width","height","resized"]},"dark":{"description":"For a dark page.","type":"object","properties":{"url":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"resized":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"width":{"type":"number"},"avif":{"type":"string"},"webp":{"type":"string"}},"required":["width","avif","webp"]}},{"type":"null"}]}},"required":["url","width","height","resized"]},"attribution":{"description":"The credit shown over the map, linking `attribution_url`.","type":"string"},"attribution_url":{"type":"string"}},"required":["light","dark","attribution","attribution_url"]},{"type":"null"}]},"feed_url":{"description":"The public feed's absolute URL, for a blog or a podcast that is published (discontinued too), listed and on a verified hostname; else null.","anyOf":[{"type":"string"},{"type":"null"}]},"description":{"description":"The page's long description, in the rich text format as stored; answered only with `full`.","anyOf":[{"type":"string"},{"type":"null"}],"x-rich-text":"text"},"what_you_get":{"description":"What a buyer gets, in the rich text format as stored; answered only with `full`.","anyOf":[{"type":"string"},{"type":"null"}],"x-rich-text":"text"},"files":{"description":"The files its prose names; answered only with `full`.","type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["video","audio","image","pdf","file"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes, null when it has none or is withheld.","anyOf":[{"type":"number"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"description":"Seconds.","anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"url":{"description":"A public file's lasting URL, an image's naming its widths' version as `#v=` once they're made; null for a private one, or one whose bytes haven't landed.","anyOf":[{"type":"string"},{"type":"null"}]},"resized":{"description":"A public image's smaller copies, narrowest first, for a `srcset`; left out until they're made and its width measured, for one kept as uploaded, and for any other file.","type":"array","items":{"type":"object","properties":{"width":{"description":"Its width in pixels, at most the image's own.","type":"integer","minimum":1},"avif":{"description":"A lasting URL to it as AVIF.","type":"string"},"webp":{"description":"A lasting URL to it as WebP.","type":"string"}},"required":["width","avif","webp"]}},"attachment_id":{"description":"The binding a private file opens through; null when the reader can't open it.","anyOf":[{"type":"string"},{"type":"null"}]},"unlocks":{"description":"What unlocks a file its own rules keep from the reader, any one; null for any other file.","anyOf":[{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product_name":{"type":"string"},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]}},"required":["product_id","product_name","tier"]}},{"type":"null"}]},"video":{"description":"A video's subtitles and published AI outputs, where its read lists any and the reader may play it.","type":"object","properties":{"attachment_id":{"type":"string"},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["attachment_id","tracks","outputs"]},"audio":{"description":"An audio file's waveform, subtitles and published AI outputs, where the reader may play it.","type":"object","properties":{"waveform":{"description":"256 levels from 0 to 255, base64, from the file's start to its end; null until drawn, or when it can't be.","anyOf":[{"type":"string"},{"type":"null"}]},"attachment_id":{"description":"The binding its tracks and outputs open through, which a public file carries here alone; null with none.","anyOf":[{"type":"string"},{"type":"null"}]},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["waveform","attachment_id","tracks","outputs"]}},"required":["id","kind","mime","name","bytes","width","height","duration","pages","status","url","attachment_id","unlocks"]}},"created":{"description":"The attachments the write bound: the files its new prose names.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string","x-extensible-enum":["prose","teaser","embed"]},"asset":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["id","role","asset"]}}},"required":["status","category","listing","id","slug","title","subtitle","priority","published_at","discontinued_at","unlisted_at","created_at","updated_at","settings","metadata","unlisted","in_use","path","url","tiers","prices","delete_blocked_by","stats","ratings","event_map","feed_url","created"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true}},"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/unlist":{"post":{"operationId":"unlistProduct","summary":"Hides a product from the store's listings while keeping its page reachable.","tags":["product"],"security":[{"bearer":["product:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Hides a product from the store's listings while keeping its page reachable.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","x-extensible-enum":["draft","scheduled","published","discontinued"]},"category":{"type":"string"},"listing":{"type":"string","x-extensible-enum":["primary","secondary"]},"id":{"type":"string"},"slug":{"type":"string"},"title":{"type":"string"},"subtitle":{"description":"The short line shown under the title.","anyOf":[{"type":"string"},{"type":"null"}]},"priority":{"type":"number"},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"discontinued_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"unlisted_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"refund_policy":{"type":"string","x-extensible-enum":["none","24h","72h","7d","14d","30d"]},"progress_tracking":{"type":"string","x-extensible-enum":["manual","disabled","on_open","on_complete"]},"reviews_enabled":{"type":"boolean"},"review_summary_visible":{"description":"Whether customers see the generated review summary; it is written either way.","type":"boolean"},"purchase_note":{"description":"Shown beside the buy button.","type":"string","minLength":1,"maxLength":2000},"approval":{"description":"Whether each buyer waits as a pending request until the seller approves or declines it; none when unset.","type":"string","x-extensible-enum":["none","required"]},"approval_payment":{"description":"How a paid purchase waits for approval; saved_card when unset. Holds last about 7 days on a card.","type":"string","x-extensible-enum":["saved_card","hold"]},"calendar":{"description":"A bookable product: the seller's Cal.com event and the host card beside the widget; writes check it, reads answer it as stored.","type":"object","properties":{"calcom":{"type":"object","properties":{"username":{"type":"string"},"event_slug":{"type":"string"}}},"host":{"type":"object","properties":{"identity":{"description":"Set apart from `title`: a write of either clears the other.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"member"},"user":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["kind","user"]},{"type":"object","properties":{"kind":{"type":"string","const":"business"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"store"}},"required":["kind"]}]},"title":{"type":"string"},"subtitle":{"type":"string"},"description":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}}}},"coffee":{"description":"A tip button: what it is called and what it shows.","type":"object","properties":{"emoji":{"type":"string"},"descriptor":{"type":"string","minLength":3,"maxLength":15,"pattern":"^\\S(.*\\S)?$"}}},"software":{"description":"A software product: how its license keys start and how many devices each holds by default.","type":"object","properties":{"key_prefix":{"description":"Letters and digits, single hyphens or underscores between them.","type":"string","minLength":1,"maxLength":16,"pattern":"^[A-Za-z0-9]+(?:[-_][A-Za-z0-9]+)*$"},"activation_limit":{"description":"The devices a license activates at once by default; none means no limit.","type":"integer","minimum":1,"maximum":10000},"inactive_days":{"description":"Days after which a device the software stopped reporting no longer counts; none keeps it until freed.","type":"integer","minimum":1,"maximum":3650},"offline_days":{"description":"Days a signed license token lets the software run offline before it asks again; 30 when unset.","type":"integer","minimum":1,"maximum":365}}},"event":{"description":"An event product: how it is attended, where, and how it takes guests.","type":"object","properties":{"format":{"description":"In person, online or both; in person when unset.","type":"string","x-extensible-enum":["in_person","online","hybrid"]},"location":{"description":"Where an in-person event takes place.","type":"object","properties":{"venue":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":200,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"address":{"description":"The street address, trimmed, its lines apart and no other control character.","type":"string","minLength":1,"maxLength":500,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u0009\\u000b\\u000c\\u000e-\\u001f\\u007f-\\u009f]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"city":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":100,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"region":{"description":"A state, province or county. Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":100,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"postal_code":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":20,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"country":{"description":"ISO 3166-1 alpha-2, upper case.","type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Z]{2}$"},"latitude":{"description":"Where it is on a map, in decimal degrees, set together with `longitude`.","type":"number","minimum":-90,"maximum":90},"longitude":{"description":"Where it is on a map, in decimal degrees, set together with `latitude`.","type":"number","minimum":-180,"maximum":180},"map_url":{"description":"A map's page for the place. An https URL.","type":"string","minLength":1,"maxLength":2000,"pattern":"^https://"}}},"reveal_location":{"description":"Who sees the location: everyone, or ticket holders alone; everyone when unset.","type":"string","x-extensible-enum":["everyone","holders"]},"waitlist":{"description":"Whether guests may join a waitlist once it is full; not when unset.","type":"boolean"},"capacity":{"description":"How many guests it takes in all; none means no limit.","type":"integer","minimum":1,"maximum":1000000}}},"fundraising":{"description":"A fundraiser: the goal, in minor units of its currency.","type":"object","properties":{"goal":{"type":"integer","minimum":1},"currency":{"type":"string","minLength":3,"maxLength":3}},"required":["goal","currency"]},"feeds":{"description":"A blog's or a podcast's feeds: the public one always stays; `private` false turns every customer's private feed off.","type":"object","properties":{"private":{"type":"boolean"},"category":{"description":"A podcast's directory category, one of Apple's, its subcategory after ` > ` (`Arts > Books`).","type":"string","maxLength":64},"explicit":{"description":"Whether a podcast's episodes are explicit; not where unset.","type":"boolean"},"owner_email":{"description":"The address directories mail to verify a podcast's owner; never in a private feed.","type":"string","maxLength":254}}},"storefront":{"type":"object","properties":{"sales_counter":{"description":"A public count of orders on the product page.","type":"boolean"},"background_poster":{"description":"The poster doubles as the page background.","type":"boolean"},"require_dark":{"description":"The page renders dark whatever the visitor chose.","type":"boolean"}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"unlisted":{"type":"boolean"},"in_use":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"count":{"type":"number"}},"required":["kind","count"]}},"poster":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"target":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"}},"required":["kind","id"]},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"from_body":{"type":"boolean"},"release_file":{"description":"A file a software release ships, which its release edits and the product's own list leaves out.","type":"boolean"},"position":{"type":"number"},"asset":{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}},"required":["id","target","role","delivery","preview_only","from_body","release_file","position","asset"]},{"type":"null"}]},"path":{"description":"The storefront path.","type":"string"},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one.","anyOf":[{"type":"string"},{"type":"null"}]},"tiers":{"type":"array","items":{"type":"object","properties":{"in_use":{"type":"object","properties":{"prices":{"type":"number"},"grants":{"type":"number"},"orders":{"type":"number"},"discounts":{"type":"number"},"gates":{"type":"number"}},"required":["prices","grants","orders","discounts","gates"]},"id":{"type":"string"},"product_id":{"type":"string"},"rank":{"type":"number"},"name":{"type":"string"},"settings":{"type":"object","properties":{"software":{"description":"A software tier: what its licenses unlock, answered by a license check.","type":"object","properties":{"features":{"description":"Distinct flags the seller's software reads: letters and digits, single hyphens, underscores, dots or colons between them.","type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9]+(?:[-_.:][A-Za-z0-9]+)*$"},"maxItems":100},"activation_limit":{"description":"The devices its licenses activate at once, over the product's default; none holds the product's.","type":"integer","minimum":1,"maximum":10000}}},"event":{"description":"An event's ticket type: how many guests it takes.","type":"object","properties":{"capacity":{"description":"How many guests this ticket type takes, within the event's own capacity; none means no limit of its own.","type":"integer","minimum":1,"maximum":1000000}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["in_use","id","product_id","rank","name","settings"]}},"prices":{"type":"array","items":{"type":"object","properties":{"in_use":{"type":"object","properties":{"orders":{"type":"number"},"subscriptions":{"type":"number"},"checkouts":{"type":"number"},"automations":{"type":"number"},"discounts":{"type":"number"}},"required":["orders","subscriptions","checkouts","automations","discounts"]},"id":{"type":"string"},"product_id":{"type":"string"},"tier_id":{"type":"string"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"type":"number"},"kind":{"type":"string","x-extensible-enum":["one_time","recurring"]},"period":{"anyOf":[{"type":"object","properties":{"unit":{"type":"string","x-extensible-enum":["day","week","month","year"]},"multiplier":{"type":"number"}},"required":["unit","multiplier"]},{"type":"null"}]},"highlighted":{"type":"boolean"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"autorenew":{"description":"Recurring only; false stops the renewal, absent renews.","type":"boolean"},"renewal_discount":{"description":"Recurring only, a percent off every renewal.","type":"integer","minimum":0,"maximum":100},"upgrade_multiplier":{"description":"One-time only, a factor on the difference paid to move up a tier.","type":"number","minimum":1,"maximum":10},"refund_policy":{"description":"Overrides the product's.","type":"string","x-extensible-enum":["none","24h","72h","7d","14d","30d"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["in_use","id","product_id","tier_id","currency","exponent","amount","kind","period","highlighted","title","description","settings","archived_at","created_at"]}},"delete_blocked_by":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"count":{"type":"number"}},"required":["kind","count"]}},"stats":{"type":"array","items":{"type":"object","properties":{"gross":{"anyOf":[{"type":"number"},{"type":"null"}]},"refunded":{"anyOf":[{"type":"number"},{"type":"null"}]},"platform_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"processor_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"affiliate_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"type":"string"},"settlement":{"type":"string","x-extensible-enum":["platform","seller","external"]},"transactions":{"type":"number"},"refunds":{"type":"number"},"buyers":{"type":"number"}},"required":["gross","refunded","platform_fee","processor_fee","affiliate_fee","exponent","currency","settlement","transactions","refunds","buyers"]}},"ratings":{"type":"object","properties":{"published":{"type":"object","properties":{"count":{"type":"number"},"average":{"anyOf":[{"type":"number"},{"type":"null"}]},"histogram":{"type":"object","properties":{"1":{"type":"number"},"2":{"type":"number"},"3":{"type":"number"},"4":{"type":"number"},"5":{"type":"number"}},"required":["1","2","3","4","5"]}},"required":["count","average","histogram"]},"live":{"type":"object","properties":{"hidden":{"type":"number"},"count":{"type":"number"},"average":{"anyOf":[{"type":"number"},{"type":"null"}]},"histogram":{"type":"object","properties":{"1":{"type":"number"},"2":{"type":"number"},"3":{"type":"number"},"4":{"type":"number"},"5":{"type":"number"}},"required":["1","2","3","4","5"]}},"required":["hidden","count","average","histogram"]}},"required":["published","live"]},"event_map":{"description":"An event's venue maps at its location's point, one image per theme; null until drawn, or for any other product.","anyOf":[{"type":"object","properties":{"light":{"description":"For a light page.","type":"object","properties":{"url":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"resized":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"width":{"type":"number"},"avif":{"type":"string"},"webp":{"type":"string"}},"required":["width","avif","webp"]}},{"type":"null"}]}},"required":["url","width","height","resized"]},"dark":{"description":"For a dark page.","type":"object","properties":{"url":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"resized":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"width":{"type":"number"},"avif":{"type":"string"},"webp":{"type":"string"}},"required":["width","avif","webp"]}},{"type":"null"}]}},"required":["url","width","height","resized"]},"attribution":{"description":"The credit shown over the map, linking `attribution_url`.","type":"string"},"attribution_url":{"type":"string"}},"required":["light","dark","attribution","attribution_url"]},{"type":"null"}]},"feed_url":{"description":"The public feed's absolute URL, for a blog or a podcast that is published (discontinued too), listed and on a verified hostname; else null.","anyOf":[{"type":"string"},{"type":"null"}]},"description":{"description":"The page's long description, in the rich text format as stored; answered only with `full`.","anyOf":[{"type":"string"},{"type":"null"}],"x-rich-text":"text"},"what_you_get":{"description":"What a buyer gets, in the rich text format as stored; answered only with `full`.","anyOf":[{"type":"string"},{"type":"null"}],"x-rich-text":"text"},"files":{"description":"The files its prose names; answered only with `full`.","type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["video","audio","image","pdf","file"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes, null when it has none or is withheld.","anyOf":[{"type":"number"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"description":"Seconds.","anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"url":{"description":"A public file's lasting URL, an image's naming its widths' version as `#v=` once they're made; null for a private one, or one whose bytes haven't landed.","anyOf":[{"type":"string"},{"type":"null"}]},"resized":{"description":"A public image's smaller copies, narrowest first, for a `srcset`; left out until they're made and its width measured, for one kept as uploaded, and for any other file.","type":"array","items":{"type":"object","properties":{"width":{"description":"Its width in pixels, at most the image's own.","type":"integer","minimum":1},"avif":{"description":"A lasting URL to it as AVIF.","type":"string"},"webp":{"description":"A lasting URL to it as WebP.","type":"string"}},"required":["width","avif","webp"]}},"attachment_id":{"description":"The binding a private file opens through; null when the reader can't open it.","anyOf":[{"type":"string"},{"type":"null"}]},"unlocks":{"description":"What unlocks a file its own rules keep from the reader, any one; null for any other file.","anyOf":[{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product_name":{"type":"string"},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]}},"required":["product_id","product_name","tier"]}},{"type":"null"}]},"video":{"description":"A video's subtitles and published AI outputs, where its read lists any and the reader may play it.","type":"object","properties":{"attachment_id":{"type":"string"},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["attachment_id","tracks","outputs"]},"audio":{"description":"An audio file's waveform, subtitles and published AI outputs, where the reader may play it.","type":"object","properties":{"waveform":{"description":"256 levels from 0 to 255, base64, from the file's start to its end; null until drawn, or when it can't be.","anyOf":[{"type":"string"},{"type":"null"}]},"attachment_id":{"description":"The binding its tracks and outputs open through, which a public file carries here alone; null with none.","anyOf":[{"type":"string"},{"type":"null"}]},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["waveform","attachment_id","tracks","outputs"]}},"required":["id","kind","mime","name","bytes","width","height","duration","pages","status","url","attachment_id","unlocks"]}},"created":{"description":"The attachments the write bound: the files its new prose names.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string","x-extensible-enum":["prose","teaser","embed"]},"asset":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["id","role","asset"]}}},"required":["status","category","listing","id","slug","title","subtitle","priority","published_at","discontinued_at","unlisted_at","created_at","updated_at","settings","metadata","unlisted","in_use","path","url","tiers","prices","delete_blocked_by","stats","ratings","event_map","feed_url","created"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true}},"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/relist":{"post":{"operationId":"relistProduct","summary":"Shows an unlisted product in the store's listings again.","tags":["product"],"security":[{"bearer":["product:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Shows an unlisted product in the store's listings again.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","x-extensible-enum":["draft","scheduled","published","discontinued"]},"category":{"type":"string"},"listing":{"type":"string","x-extensible-enum":["primary","secondary"]},"id":{"type":"string"},"slug":{"type":"string"},"title":{"type":"string"},"subtitle":{"description":"The short line shown under the title.","anyOf":[{"type":"string"},{"type":"null"}]},"priority":{"type":"number"},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"discontinued_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"unlisted_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"refund_policy":{"type":"string","x-extensible-enum":["none","24h","72h","7d","14d","30d"]},"progress_tracking":{"type":"string","x-extensible-enum":["manual","disabled","on_open","on_complete"]},"reviews_enabled":{"type":"boolean"},"review_summary_visible":{"description":"Whether customers see the generated review summary; it is written either way.","type":"boolean"},"purchase_note":{"description":"Shown beside the buy button.","type":"string","minLength":1,"maxLength":2000},"approval":{"description":"Whether each buyer waits as a pending request until the seller approves or declines it; none when unset.","type":"string","x-extensible-enum":["none","required"]},"approval_payment":{"description":"How a paid purchase waits for approval; saved_card when unset. Holds last about 7 days on a card.","type":"string","x-extensible-enum":["saved_card","hold"]},"calendar":{"description":"A bookable product: the seller's Cal.com event and the host card beside the widget; writes check it, reads answer it as stored.","type":"object","properties":{"calcom":{"type":"object","properties":{"username":{"type":"string"},"event_slug":{"type":"string"}}},"host":{"type":"object","properties":{"identity":{"description":"Set apart from `title`: a write of either clears the other.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"member"},"user":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["kind","user"]},{"type":"object","properties":{"kind":{"type":"string","const":"business"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"store"}},"required":["kind"]}]},"title":{"type":"string"},"subtitle":{"type":"string"},"description":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}}}},"coffee":{"description":"A tip button: what it is called and what it shows.","type":"object","properties":{"emoji":{"type":"string"},"descriptor":{"type":"string","minLength":3,"maxLength":15,"pattern":"^\\S(.*\\S)?$"}}},"software":{"description":"A software product: how its license keys start and how many devices each holds by default.","type":"object","properties":{"key_prefix":{"description":"Letters and digits, single hyphens or underscores between them.","type":"string","minLength":1,"maxLength":16,"pattern":"^[A-Za-z0-9]+(?:[-_][A-Za-z0-9]+)*$"},"activation_limit":{"description":"The devices a license activates at once by default; none means no limit.","type":"integer","minimum":1,"maximum":10000},"inactive_days":{"description":"Days after which a device the software stopped reporting no longer counts; none keeps it until freed.","type":"integer","minimum":1,"maximum":3650},"offline_days":{"description":"Days a signed license token lets the software run offline before it asks again; 30 when unset.","type":"integer","minimum":1,"maximum":365}}},"event":{"description":"An event product: how it is attended, where, and how it takes guests.","type":"object","properties":{"format":{"description":"In person, online or both; in person when unset.","type":"string","x-extensible-enum":["in_person","online","hybrid"]},"location":{"description":"Where an in-person event takes place.","type":"object","properties":{"venue":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":200,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"address":{"description":"The street address, trimmed, its lines apart and no other control character.","type":"string","minLength":1,"maxLength":500,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u0009\\u000b\\u000c\\u000e-\\u001f\\u007f-\\u009f]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"city":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":100,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"region":{"description":"A state, province or county. Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":100,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"postal_code":{"description":"Trimmed, with no line break or control character.","type":"string","minLength":1,"maxLength":20,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},"country":{"description":"ISO 3166-1 alpha-2, upper case.","type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Z]{2}$"},"latitude":{"description":"Where it is on a map, in decimal degrees, set together with `longitude`.","type":"number","minimum":-90,"maximum":90},"longitude":{"description":"Where it is on a map, in decimal degrees, set together with `latitude`.","type":"number","minimum":-180,"maximum":180},"map_url":{"description":"A map's page for the place. An https URL.","type":"string","minLength":1,"maxLength":2000,"pattern":"^https://"}}},"reveal_location":{"description":"Who sees the location: everyone, or ticket holders alone; everyone when unset.","type":"string","x-extensible-enum":["everyone","holders"]},"waitlist":{"description":"Whether guests may join a waitlist once it is full; not when unset.","type":"boolean"},"capacity":{"description":"How many guests it takes in all; none means no limit.","type":"integer","minimum":1,"maximum":1000000}}},"fundraising":{"description":"A fundraiser: the goal, in minor units of its currency.","type":"object","properties":{"goal":{"type":"integer","minimum":1},"currency":{"type":"string","minLength":3,"maxLength":3}},"required":["goal","currency"]},"feeds":{"description":"A blog's or a podcast's feeds: the public one always stays; `private` false turns every customer's private feed off.","type":"object","properties":{"private":{"type":"boolean"},"category":{"description":"A podcast's directory category, one of Apple's, its subcategory after ` > ` (`Arts > Books`).","type":"string","maxLength":64},"explicit":{"description":"Whether a podcast's episodes are explicit; not where unset.","type":"boolean"},"owner_email":{"description":"The address directories mail to verify a podcast's owner; never in a private feed.","type":"string","maxLength":254}}},"storefront":{"type":"object","properties":{"sales_counter":{"description":"A public count of orders on the product page.","type":"boolean"},"background_poster":{"description":"The poster doubles as the page background.","type":"boolean"},"require_dark":{"description":"The page renders dark whatever the visitor chose.","type":"boolean"}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"unlisted":{"type":"boolean"},"in_use":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"count":{"type":"number"}},"required":["kind","count"]}},"poster":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"target":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"}},"required":["kind","id"]},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"from_body":{"type":"boolean"},"release_file":{"description":"A file a software release ships, which its release edits and the product's own list leaves out.","type":"boolean"},"position":{"type":"number"},"asset":{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}},"required":["id","target","role","delivery","preview_only","from_body","release_file","position","asset"]},{"type":"null"}]},"path":{"description":"The storefront path.","type":"string"},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one.","anyOf":[{"type":"string"},{"type":"null"}]},"tiers":{"type":"array","items":{"type":"object","properties":{"in_use":{"type":"object","properties":{"prices":{"type":"number"},"grants":{"type":"number"},"orders":{"type":"number"},"discounts":{"type":"number"},"gates":{"type":"number"}},"required":["prices","grants","orders","discounts","gates"]},"id":{"type":"string"},"product_id":{"type":"string"},"rank":{"type":"number"},"name":{"type":"string"},"settings":{"type":"object","properties":{"software":{"description":"A software tier: what its licenses unlock, answered by a license check.","type":"object","properties":{"features":{"description":"Distinct flags the seller's software reads: letters and digits, single hyphens, underscores, dots or colons between them.","type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9]+(?:[-_.:][A-Za-z0-9]+)*$"},"maxItems":100},"activation_limit":{"description":"The devices its licenses activate at once, over the product's default; none holds the product's.","type":"integer","minimum":1,"maximum":10000}}},"event":{"description":"An event's ticket type: how many guests it takes.","type":"object","properties":{"capacity":{"description":"How many guests this ticket type takes, within the event's own capacity; none means no limit of its own.","type":"integer","minimum":1,"maximum":1000000}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["in_use","id","product_id","rank","name","settings"]}},"prices":{"type":"array","items":{"type":"object","properties":{"in_use":{"type":"object","properties":{"orders":{"type":"number"},"subscriptions":{"type":"number"},"checkouts":{"type":"number"},"automations":{"type":"number"},"discounts":{"type":"number"}},"required":["orders","subscriptions","checkouts","automations","discounts"]},"id":{"type":"string"},"product_id":{"type":"string"},"tier_id":{"type":"string"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"type":"number"},"kind":{"type":"string","x-extensible-enum":["one_time","recurring"]},"period":{"anyOf":[{"type":"object","properties":{"unit":{"type":"string","x-extensible-enum":["day","week","month","year"]},"multiplier":{"type":"number"}},"required":["unit","multiplier"]},{"type":"null"}]},"highlighted":{"type":"boolean"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"autorenew":{"description":"Recurring only; false stops the renewal, absent renews.","type":"boolean"},"renewal_discount":{"description":"Recurring only, a percent off every renewal.","type":"integer","minimum":0,"maximum":100},"upgrade_multiplier":{"description":"One-time only, a factor on the difference paid to move up a tier.","type":"number","minimum":1,"maximum":10},"refund_policy":{"description":"Overrides the product's.","type":"string","x-extensible-enum":["none","24h","72h","7d","14d","30d"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["in_use","id","product_id","tier_id","currency","exponent","amount","kind","period","highlighted","title","description","settings","archived_at","created_at"]}},"delete_blocked_by":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"count":{"type":"number"}},"required":["kind","count"]}},"stats":{"type":"array","items":{"type":"object","properties":{"gross":{"anyOf":[{"type":"number"},{"type":"null"}]},"refunded":{"anyOf":[{"type":"number"},{"type":"null"}]},"platform_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"processor_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"affiliate_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"type":"string"},"settlement":{"type":"string","x-extensible-enum":["platform","seller","external"]},"transactions":{"type":"number"},"refunds":{"type":"number"},"buyers":{"type":"number"}},"required":["gross","refunded","platform_fee","processor_fee","affiliate_fee","exponent","currency","settlement","transactions","refunds","buyers"]}},"ratings":{"type":"object","properties":{"published":{"type":"object","properties":{"count":{"type":"number"},"average":{"anyOf":[{"type":"number"},{"type":"null"}]},"histogram":{"type":"object","properties":{"1":{"type":"number"},"2":{"type":"number"},"3":{"type":"number"},"4":{"type":"number"},"5":{"type":"number"}},"required":["1","2","3","4","5"]}},"required":["count","average","histogram"]},"live":{"type":"object","properties":{"hidden":{"type":"number"},"count":{"type":"number"},"average":{"anyOf":[{"type":"number"},{"type":"null"}]},"histogram":{"type":"object","properties":{"1":{"type":"number"},"2":{"type":"number"},"3":{"type":"number"},"4":{"type":"number"},"5":{"type":"number"}},"required":["1","2","3","4","5"]}},"required":["hidden","count","average","histogram"]}},"required":["published","live"]},"event_map":{"description":"An event's venue maps at its location's point, one image per theme; null until drawn, or for any other product.","anyOf":[{"type":"object","properties":{"light":{"description":"For a light page.","type":"object","properties":{"url":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"resized":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"width":{"type":"number"},"avif":{"type":"string"},"webp":{"type":"string"}},"required":["width","avif","webp"]}},{"type":"null"}]}},"required":["url","width","height","resized"]},"dark":{"description":"For a dark page.","type":"object","properties":{"url":{"type":"string"},"width":{"type":"number"},"height":{"type":"number"},"resized":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"width":{"type":"number"},"avif":{"type":"string"},"webp":{"type":"string"}},"required":["width","avif","webp"]}},{"type":"null"}]}},"required":["url","width","height","resized"]},"attribution":{"description":"The credit shown over the map, linking `attribution_url`.","type":"string"},"attribution_url":{"type":"string"}},"required":["light","dark","attribution","attribution_url"]},{"type":"null"}]},"feed_url":{"description":"The public feed's absolute URL, for a blog or a podcast that is published (discontinued too), listed and on a verified hostname; else null.","anyOf":[{"type":"string"},{"type":"null"}]},"description":{"description":"The page's long description, in the rich text format as stored; answered only with `full`.","anyOf":[{"type":"string"},{"type":"null"}],"x-rich-text":"text"},"what_you_get":{"description":"What a buyer gets, in the rich text format as stored; answered only with `full`.","anyOf":[{"type":"string"},{"type":"null"}],"x-rich-text":"text"},"files":{"description":"The files its prose names; answered only with `full`.","type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["video","audio","image","pdf","file"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes, null when it has none or is withheld.","anyOf":[{"type":"number"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"description":"Seconds.","anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"url":{"description":"A public file's lasting URL, an image's naming its widths' version as `#v=` once they're made; null for a private one, or one whose bytes haven't landed.","anyOf":[{"type":"string"},{"type":"null"}]},"resized":{"description":"A public image's smaller copies, narrowest first, for a `srcset`; left out until they're made and its width measured, for one kept as uploaded, and for any other file.","type":"array","items":{"type":"object","properties":{"width":{"description":"Its width in pixels, at most the image's own.","type":"integer","minimum":1},"avif":{"description":"A lasting URL to it as AVIF.","type":"string"},"webp":{"description":"A lasting URL to it as WebP.","type":"string"}},"required":["width","avif","webp"]}},"attachment_id":{"description":"The binding a private file opens through; null when the reader can't open it.","anyOf":[{"type":"string"},{"type":"null"}]},"unlocks":{"description":"What unlocks a file its own rules keep from the reader, any one; null for any other file.","anyOf":[{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product_name":{"type":"string"},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]}},"required":["product_id","product_name","tier"]}},{"type":"null"}]},"video":{"description":"A video's subtitles and published AI outputs, where its read lists any and the reader may play it.","type":"object","properties":{"attachment_id":{"type":"string"},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["attachment_id","tracks","outputs"]},"audio":{"description":"An audio file's waveform, subtitles and published AI outputs, where the reader may play it.","type":"object","properties":{"waveform":{"description":"256 levels from 0 to 255, base64, from the file's start to its end; null until drawn, or when it can't be.","anyOf":[{"type":"string"},{"type":"null"}]},"attachment_id":{"description":"The binding its tracks and outputs open through, which a public file carries here alone; null with none.","anyOf":[{"type":"string"},{"type":"null"}]},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["waveform","attachment_id","tracks","outputs"]}},"required":["id","kind","mime","name","bytes","width","height","duration","pages","status","url","attachment_id","unlocks"]}},"created":{"description":"The attachments the write bound: the files its new prose names.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string","x-extensible-enum":["prose","teaser","embed"]},"asset":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["id","role","asset"]}}},"required":["status","category","listing","id","slug","title","subtitle","priority","published_at","discontinued_at","unlisted_at","created_at","updated_at","settings","metadata","unlisted","in_use","path","url","tiers","prices","delete_blocked_by","stats","ratings","event_map","feed_url","created"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true}},"additionalProperties":false}}}}}},"/v1/stores/{store}/tiers":{"get":{"operationId":"listTiers","summary":"Pages the tiers of the store's products, or of one product.","tags":["product"],"security":[{"bearer":["product:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"query","description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1,"description":"An id, or `slug:<slug>`."}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["product"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Pages the tiers of the store's products, or of one product.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"in_use":{"type":"object","properties":{"prices":{"type":"number"},"grants":{"type":"number"},"orders":{"type":"number"},"discounts":{"type":"number"},"gates":{"type":"number"}},"required":["prices","grants","orders","discounts","gates"]},"id":{"type":"string"},"product_id":{"type":"string"},"rank":{"type":"number"},"name":{"type":"string"},"settings":{"type":"object","properties":{"software":{"description":"A software tier: what its licenses unlock, answered by a license check.","type":"object","properties":{"features":{"description":"Distinct flags the seller's software reads: letters and digits, single hyphens, underscores, dots or colons between them.","type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9]+(?:[-_.:][A-Za-z0-9]+)*$"},"maxItems":100},"activation_limit":{"description":"The devices its licenses activate at once, over the product's default; none holds the product's.","type":"integer","minimum":1,"maximum":10000}}},"event":{"description":"An event's ticket type: how many guests it takes.","type":"object","properties":{"capacity":{"description":"How many guests this ticket type takes, within the event's own capacity; none means no limit of its own.","type":"integer","minimum":1,"maximum":1000000}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["product","in_use","id","product_id","rank","name","settings"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/tiers":{"get":{"operationId":"listProductTiers","summary":"Pages the tiers of the store's products, or of one product.","tags":["product"],"security":[{"bearer":["product:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["product"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Pages the tiers of the store's products, or of one product.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"in_use":{"type":"object","properties":{"prices":{"type":"number"},"grants":{"type":"number"},"orders":{"type":"number"},"discounts":{"type":"number"},"gates":{"type":"number"}},"required":["prices","grants","orders","discounts","gates"]},"id":{"type":"string"},"product_id":{"type":"string"},"rank":{"type":"number"},"name":{"type":"string"},"settings":{"type":"object","properties":{"software":{"description":"A software tier: what its licenses unlock, answered by a license check.","type":"object","properties":{"features":{"description":"Distinct flags the seller's software reads: letters and digits, single hyphens, underscores, dots or colons between them.","type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9]+(?:[-_.:][A-Za-z0-9]+)*$"},"maxItems":100},"activation_limit":{"description":"The devices its licenses activate at once, over the product's default; none holds the product's.","type":"integer","minimum":1,"maximum":10000}}},"event":{"description":"An event's ticket type: how many guests it takes.","type":"object","properties":{"capacity":{"description":"How many guests this ticket type takes, within the event's own capacity; none means no limit of its own.","type":"integer","minimum":1,"maximum":1000000}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["product","in_use","id","product_id","rank","name","settings"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"post":{"operationId":"createTier","summary":"Adds a tier to a product, with the settings its category takes, such as the features a software tier's licenses unlock.","tags":["product"],"security":[{"bearer":["product:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"201":{"description":"Adds a tier to a product, with the settings its category takes, such as the features a software tier's licenses unlock.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"in_use":{"type":"object","properties":{"prices":{"type":"number"},"grants":{"type":"number"},"orders":{"type":"number"},"discounts":{"type":"number"},"gates":{"type":"number"}},"required":["prices","grants","orders","discounts","gates"]},"id":{"type":"string"},"product_id":{"type":"string"},"rank":{"type":"number"},"name":{"type":"string"},"settings":{"type":"object","properties":{"software":{"description":"A software tier: what its licenses unlock, answered by a license check.","type":"object","properties":{"features":{"description":"Distinct flags the seller's software reads: letters and digits, single hyphens, underscores, dots or colons between them.","type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9]+(?:[-_.:][A-Za-z0-9]+)*$"},"maxItems":100},"activation_limit":{"description":"The devices its licenses activate at once, over the product's default; none holds the product's.","type":"integer","minimum":1,"maximum":10000}}},"event":{"description":"An event's ticket type: how many guests it takes.","type":"object","properties":{"capacity":{"description":"How many guests this ticket type takes, within the event's own capacity; none means no limit of its own.","type":"integer","minimum":1,"maximum":1000000}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["in_use","id","product_id","rank","name","settings"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"settings":{"description":"What the tier's holders get by the product's category; `software` only on a software product, `event` on an event.","type":"object","properties":{"software":{"description":"A software tier: what its licenses unlock, answered by a license check.","type":"object","properties":{"features":{"description":"Distinct flags the seller's software reads: letters and digits, single hyphens, underscores, dots or colons between them.","type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9]+(?:[-_.:][A-Za-z0-9]+)*$"},"maxItems":100},"activation_limit":{"description":"The devices its licenses activate at once, over the product's default; none holds the product's.","type":"integer","minimum":1,"maximum":10000}},"additionalProperties":false},"event":{"description":"An event's ticket type: how many guests it takes.","type":"object","properties":{"capacity":{"description":"How many guests this ticket type takes, within the event's own capacity; none means no limit of its own.","type":"integer","minimum":1,"maximum":1000000}},"additionalProperties":false}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["name"],"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/tiers/{tier}":{"patch":{"operationId":"updateTier","summary":"Renames a tier or changes its settings, such as the features a software tier's licenses unlock.","tags":["product"],"security":[{"bearer":["product:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"tier","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Renames a tier or changes its settings, such as the features a software tier's licenses unlock.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"in_use":{"type":"object","properties":{"prices":{"type":"number"},"grants":{"type":"number"},"orders":{"type":"number"},"discounts":{"type":"number"},"gates":{"type":"number"}},"required":["prices","grants","orders","discounts","gates"]},"id":{"type":"string"},"product_id":{"type":"string"},"rank":{"type":"number"},"name":{"type":"string"},"settings":{"type":"object","properties":{"software":{"description":"A software tier: what its licenses unlock, answered by a license check.","type":"object","properties":{"features":{"description":"Distinct flags the seller's software reads: letters and digits, single hyphens, underscores, dots or colons between them.","type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9]+(?:[-_.:][A-Za-z0-9]+)*$"},"maxItems":100},"activation_limit":{"description":"The devices its licenses activate at once, over the product's default; none holds the product's.","type":"integer","minimum":1,"maximum":10000}}},"event":{"description":"An event's ticket type: how many guests it takes.","type":"object","properties":{"capacity":{"description":"How many guests this ticket type takes, within the event's own capacity; none means no limit of its own.","type":"integer","minimum":1,"maximum":1000000}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["in_use","id","product_id","rank","name","settings"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"settings":{"description":"Merged onto the stored settings; null deletes a key.","type":"object","properties":{"software":{"description":"A software tier: what its licenses unlock, answered by a license check.","anyOf":[{"type":"object","properties":{"features":{"description":"Distinct flags the seller's software reads: letters and digits, single hyphens, underscores, dots or colons between them.","anyOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9]+(?:[-_.:][A-Za-z0-9]+)*$"},"maxItems":100},{"type":"null"}]},"activation_limit":{"description":"The devices its licenses activate at once, over the product's default; none holds the product's.","anyOf":[{"type":"integer","minimum":1,"maximum":10000},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]},"event":{"description":"An event's ticket type: how many guests it takes.","anyOf":[{"type":"object","properties":{"capacity":{"description":"How many guests this ticket type takes, within the event's own capacity; none means no limit of its own.","anyOf":[{"type":"integer","minimum":1,"maximum":1000000},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"additionalProperties":false}}}}},"delete":{"operationId":"deleteTier","summary":"Deletes a tier no price or holder refers to.","tags":["product"],"security":[{"bearer":["product:delete"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"tier","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Deletes a tier no price or holder refers to.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean","const":true}},"required":["id","deleted"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/tiers/reorder":{"post":{"operationId":"reorderTiers","summary":"Sets the order of a product's tiers.","tags":["product"],"security":[{"bearer":["product:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Sets the order of a product's tiers.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"in_use":{"type":"object","properties":{"prices":{"type":"number"},"grants":{"type":"number"},"orders":{"type":"number"},"discounts":{"type":"number"},"gates":{"type":"number"}},"required":["prices","grants","orders","discounts","gates"]},"id":{"type":"string"},"product_id":{"type":"string"},"rank":{"type":"number"},"name":{"type":"string"},"settings":{"type":"object","properties":{"software":{"description":"A software tier: what its licenses unlock, answered by a license check.","type":"object","properties":{"features":{"description":"Distinct flags the seller's software reads: letters and digits, single hyphens, underscores, dots or colons between them.","type":"array","items":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9]+(?:[-_.:][A-Za-z0-9]+)*$"},"maxItems":100},"activation_limit":{"description":"The devices its licenses activate at once, over the product's default; none holds the product's.","type":"integer","minimum":1,"maximum":10000}}},"event":{"description":"An event's ticket type: how many guests it takes.","type":"object","properties":{"capacity":{"description":"How many guests this ticket type takes, within the event's own capacity; none means no limit of its own.","type":"integer","minimum":1,"maximum":1000000}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["in_use","id","product_id","rank","name","settings"]}}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tiers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"minItems":1,"maxItems":10000},"from":{"description":"The order the seller saw; a reorder over a moved order is refused.","type":"object","properties":{"tiers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"minItems":1,"maxItems":10000}},"required":["tiers"],"additionalProperties":false}},"required":["tiers"],"additionalProperties":false}}}}}},"/v1/stores/{store}/prices":{"get":{"operationId":"listPrices","summary":"Pages the prices of the store's products, or of one product.","tags":["price"],"security":[{"bearer":["price:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"query","description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1,"description":"An id, or `slug:<slug>`."}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["product"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Pages the prices of the store's products, or of one product.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},{"type":"null"}]},"in_use":{"type":"object","properties":{"orders":{"type":"number"},"subscriptions":{"type":"number"},"checkouts":{"type":"number"},"automations":{"type":"number"},"discounts":{"type":"number"}},"required":["orders","subscriptions","checkouts","automations","discounts"]},"id":{"type":"string"},"product_id":{"type":"string"},"tier_id":{"type":"string"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"type":"number"},"kind":{"type":"string","x-extensible-enum":["one_time","recurring"]},"period":{"anyOf":[{"type":"object","properties":{"unit":{"type":"string","x-extensible-enum":["day","week","month","year"]},"multiplier":{"type":"number"}},"required":["unit","multiplier"]},{"type":"null"}]},"highlighted":{"type":"boolean"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"autorenew":{"description":"Recurring only; false stops the renewal, absent renews.","type":"boolean"},"renewal_discount":{"description":"Recurring only, a percent off every renewal.","type":"integer","minimum":0,"maximum":100},"upgrade_multiplier":{"description":"One-time only, a factor on the difference paid to move up a tier.","type":"number","minimum":1,"maximum":10},"refund_policy":{"description":"Overrides the product's.","type":"string","x-extensible-enum":["none","24h","72h","7d","14d","30d"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["product","tier","in_use","id","product_id","tier_id","currency","exponent","amount","kind","period","highlighted","title","description","settings","archived_at","created_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/prices":{"get":{"operationId":"listProductPrices","summary":"Pages the prices of the store's products, or of one product.","tags":["price"],"security":[{"bearer":["price:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["product"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Pages the prices of the store's products, or of one product.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},{"type":"null"}]},"in_use":{"type":"object","properties":{"orders":{"type":"number"},"subscriptions":{"type":"number"},"checkouts":{"type":"number"},"automations":{"type":"number"},"discounts":{"type":"number"}},"required":["orders","subscriptions","checkouts","automations","discounts"]},"id":{"type":"string"},"product_id":{"type":"string"},"tier_id":{"type":"string"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"type":"number"},"kind":{"type":"string","x-extensible-enum":["one_time","recurring"]},"period":{"anyOf":[{"type":"object","properties":{"unit":{"type":"string","x-extensible-enum":["day","week","month","year"]},"multiplier":{"type":"number"}},"required":["unit","multiplier"]},{"type":"null"}]},"highlighted":{"type":"boolean"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"autorenew":{"description":"Recurring only; false stops the renewal, absent renews.","type":"boolean"},"renewal_discount":{"description":"Recurring only, a percent off every renewal.","type":"integer","minimum":0,"maximum":100},"upgrade_multiplier":{"description":"One-time only, a factor on the difference paid to move up a tier.","type":"number","minimum":1,"maximum":10},"refund_policy":{"description":"Overrides the product's.","type":"string","x-extensible-enum":["none","24h","72h","7d","14d","30d"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["product","tier","in_use","id","product_id","tier_id","currency","exponent","amount","kind","period","highlighted","title","description","settings","archived_at","created_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"post":{"operationId":"createPrice","summary":"Adds a price to a product's tier.","tags":["price"],"security":[{"bearer":["price:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"201":{"description":"Adds a price to a product's tier.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"in_use":{"type":"object","properties":{"orders":{"type":"number"},"subscriptions":{"type":"number"},"checkouts":{"type":"number"},"automations":{"type":"number"},"discounts":{"type":"number"}},"required":["orders","subscriptions","checkouts","automations","discounts"]},"id":{"type":"string"},"product_id":{"type":"string"},"tier_id":{"type":"string"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"type":"number"},"kind":{"type":"string","x-extensible-enum":["one_time","recurring"]},"period":{"anyOf":[{"type":"object","properties":{"unit":{"type":"string","x-extensible-enum":["day","week","month","year"]},"multiplier":{"type":"number"}},"required":["unit","multiplier"]},{"type":"null"}]},"highlighted":{"type":"boolean"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"autorenew":{"description":"Recurring only; false stops the renewal, absent renews.","type":"boolean"},"renewal_discount":{"description":"Recurring only, a percent off every renewal.","type":"integer","minimum":0,"maximum":100},"upgrade_multiplier":{"description":"One-time only, a factor on the difference paid to move up a tier.","type":"number","minimum":1,"maximum":10},"refund_policy":{"description":"Overrides the product's.","type":"string","x-extensible-enum":["none","24h","72h","7d","14d","30d"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["in_use","id","product_id","tier_id","currency","exponent","amount","kind","period","highlighted","title","description","settings","archived_at","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tier":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"currency":{"type":"string","minLength":3,"maxLength":3},"amount":{"type":"integer","minimum":0,"maximum":9007199254740991},"kind":{"type":"string","enum":["one_time","recurring"]},"period":{"type":"object","properties":{"unit":{"type":"string","enum":["day","week","month","year"]},"multiplier":{"type":"integer","minimum":1,"maximum":365}},"required":["unit"],"additionalProperties":false},"highlighted":{"type":"boolean"},"title":{"description":"Shown in place of the tier's name where the price is offered.","anyOf":[{"type":"string","minLength":1,"maxLength":30},{"type":"null"}]},"description":{"anyOf":[{"type":"string","minLength":1,"maxLength":50},{"type":"null"}]},"settings":{"type":"object","properties":{"autorenew":{"description":"Recurring only; false stops the renewal, absent renews.","type":"boolean"},"renewal_discount":{"description":"Recurring only, a percent off every renewal.","type":"integer","minimum":0,"maximum":100},"upgrade_multiplier":{"description":"One-time only, a factor on the difference paid to move up a tier.","type":"number","minimum":1,"maximum":10},"refund_policy":{"description":"Overrides the product's.","type":"string","enum":["none","24h","72h","7d","14d","30d"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["tier","currency","amount"],"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/prices/{price}":{"patch":{"operationId":"updatePrice","summary":"Updates a price's fields.","tags":["price"],"security":[{"bearer":["price:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"price","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Updates a price's fields.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"in_use":{"type":"object","properties":{"orders":{"type":"number"},"subscriptions":{"type":"number"},"checkouts":{"type":"number"},"automations":{"type":"number"},"discounts":{"type":"number"}},"required":["orders","subscriptions","checkouts","automations","discounts"]},"id":{"type":"string"},"product_id":{"type":"string"},"tier_id":{"type":"string"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"type":"number"},"kind":{"type":"string","x-extensible-enum":["one_time","recurring"]},"period":{"anyOf":[{"type":"object","properties":{"unit":{"type":"string","x-extensible-enum":["day","week","month","year"]},"multiplier":{"type":"number"}},"required":["unit","multiplier"]},{"type":"null"}]},"highlighted":{"type":"boolean"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"autorenew":{"description":"Recurring only; false stops the renewal, absent renews.","type":"boolean"},"renewal_discount":{"description":"Recurring only, a percent off every renewal.","type":"integer","minimum":0,"maximum":100},"upgrade_multiplier":{"description":"One-time only, a factor on the difference paid to move up a tier.","type":"number","minimum":1,"maximum":10},"refund_policy":{"description":"Overrides the product's.","type":"string","x-extensible-enum":["none","24h","72h","7d","14d","30d"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["in_use","id","product_id","tier_id","currency","exponent","amount","kind","period","highlighted","title","description","settings","archived_at","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"amount":{"type":"integer","minimum":0,"maximum":9007199254740991},"title":{"description":"Null clears it.","anyOf":[{"type":"string","minLength":1,"maxLength":30},{"type":"null"}]},"description":{"anyOf":[{"type":"string","minLength":1,"maxLength":50},{"type":"null"}]},"settings":{"description":"Merged onto the stored settings; null deletes a key.","type":"object","properties":{"autorenew":{"description":"Recurring only; false stops the renewal, absent renews.","anyOf":[{"type":"boolean"},{"type":"null"}]},"renewal_discount":{"description":"Recurring only, a percent off every renewal.","anyOf":[{"type":"integer","minimum":0,"maximum":100},{"type":"null"}]},"upgrade_multiplier":{"description":"One-time only, a factor on the difference paid to move up a tier.","anyOf":[{"type":"number","minimum":1,"maximum":10},{"type":"null"}]},"refund_policy":{"description":"Overrides the product's.","anyOf":[{"type":"string","enum":["none","24h","72h","7d","14d","30d"]},{"type":"null"}]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"additionalProperties":false}}}}},"delete":{"operationId":"deletePrice","summary":"Deletes a price no order or subscription refers to.","tags":["price"],"security":[{"bearer":["price:delete"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"price","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Deletes a price no order or subscription refers to.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean","const":true}},"required":["id","deleted"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/prices/{price}/highlight":{"post":{"operationId":"highlightPrice","summary":"Makes a price the one a product's page features.","tags":["price"],"security":[{"bearer":["price:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"price","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Makes a price the one a product's page features.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"in_use":{"type":"object","properties":{"orders":{"type":"number"},"subscriptions":{"type":"number"},"checkouts":{"type":"number"},"automations":{"type":"number"},"discounts":{"type":"number"}},"required":["orders","subscriptions","checkouts","automations","discounts"]},"id":{"type":"string"},"product_id":{"type":"string"},"tier_id":{"type":"string"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"type":"number"},"kind":{"type":"string","x-extensible-enum":["one_time","recurring"]},"period":{"anyOf":[{"type":"object","properties":{"unit":{"type":"string","x-extensible-enum":["day","week","month","year"]},"multiplier":{"type":"number"}},"required":["unit","multiplier"]},{"type":"null"}]},"highlighted":{"type":"boolean"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"autorenew":{"description":"Recurring only; false stops the renewal, absent renews.","type":"boolean"},"renewal_discount":{"description":"Recurring only, a percent off every renewal.","type":"integer","minimum":0,"maximum":100},"upgrade_multiplier":{"description":"One-time only, a factor on the difference paid to move up a tier.","type":"number","minimum":1,"maximum":10},"refund_policy":{"description":"Overrides the product's.","type":"string","x-extensible-enum":["none","24h","72h","7d","14d","30d"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["in_use","id","product_id","tier_id","currency","exponent","amount","kind","period","highlighted","title","description","settings","archived_at","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/prices/{price}/archive":{"post":{"operationId":"archivePrice","summary":"Stops offering a price while keeping it for its buyers.","tags":["price"],"security":[{"bearer":["price:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"price","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Stops offering a price while keeping it for its buyers.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"in_use":{"type":"object","properties":{"orders":{"type":"number"},"subscriptions":{"type":"number"},"checkouts":{"type":"number"},"automations":{"type":"number"},"discounts":{"type":"number"}},"required":["orders","subscriptions","checkouts","automations","discounts"]},"id":{"type":"string"},"product_id":{"type":"string"},"tier_id":{"type":"string"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"type":"number"},"kind":{"type":"string","x-extensible-enum":["one_time","recurring"]},"period":{"anyOf":[{"type":"object","properties":{"unit":{"type":"string","x-extensible-enum":["day","week","month","year"]},"multiplier":{"type":"number"}},"required":["unit","multiplier"]},{"type":"null"}]},"highlighted":{"type":"boolean"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"autorenew":{"description":"Recurring only; false stops the renewal, absent renews.","type":"boolean"},"renewal_discount":{"description":"Recurring only, a percent off every renewal.","type":"integer","minimum":0,"maximum":100},"upgrade_multiplier":{"description":"One-time only, a factor on the difference paid to move up a tier.","type":"number","minimum":1,"maximum":10},"refund_policy":{"description":"Overrides the product's.","type":"string","x-extensible-enum":["none","24h","72h","7d","14d","30d"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["in_use","id","product_id","tier_id","currency","exponent","amount","kind","period","highlighted","title","description","settings","archived_at","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/prices/{price}/restore":{"post":{"operationId":"restorePrice","summary":"Offers an archived price again.","tags":["price"],"security":[{"bearer":["price:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"price","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Offers an archived price again.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"in_use":{"type":"object","properties":{"orders":{"type":"number"},"subscriptions":{"type":"number"},"checkouts":{"type":"number"},"automations":{"type":"number"},"discounts":{"type":"number"}},"required":["orders","subscriptions","checkouts","automations","discounts"]},"id":{"type":"string"},"product_id":{"type":"string"},"tier_id":{"type":"string"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"type":"number"},"kind":{"type":"string","x-extensible-enum":["one_time","recurring"]},"period":{"anyOf":[{"type":"object","properties":{"unit":{"type":"string","x-extensible-enum":["day","week","month","year"]},"multiplier":{"type":"number"}},"required":["unit","multiplier"]},{"type":"null"}]},"highlighted":{"type":"boolean"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"autorenew":{"description":"Recurring only; false stops the renewal, absent renews.","type":"boolean"},"renewal_discount":{"description":"Recurring only, a percent off every renewal.","type":"integer","minimum":0,"maximum":100},"upgrade_multiplier":{"description":"One-time only, a factor on the difference paid to move up a tier.","type":"number","minimum":1,"maximum":10},"refund_policy":{"description":"Overrides the product's.","type":"string","x-extensible-enum":["none","24h","72h","7d","14d","30d"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["in_use","id","product_id","tier_id","currency","exponent","amount","kind","period","highlighted","title","description","settings","archived_at","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/entries":{"get":{"operationId":"listEntries","summary":"Pages a product's entries, a blog's drafts first then newest first, a podcast's newest first, unless sorted.","tags":["entry"],"security":[{"bearer":["entry:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","description":"Sorted by published, rows without a value come last either way. Sorted by latest, rows without a value come first either way.","schema":{"type":"string","enum":["position","created","published","latest","title"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"search","in":"query","schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Pages a product's entries, a blog's drafts first then newest first, a podcast's newest first, unless sorted.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"summary":{"type":"object","properties":{"poster":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]},{"type":"null"}]},"has_video":{"type":"boolean"},"duration":{"anyOf":[{"type":"number"},{"type":"null"}]},"presentations":{"type":"number"},"slides":{"type":"number"},"files":{"type":"number"},"links":{"type":"number"},"has_body":{"type":"boolean"},"has_quiz":{"type":"boolean"},"has_certificate":{"type":"boolean"}},"required":["poster","has_video","duration","presentations","slides","files","links","has_body","has_quiz","has_certificate"]},"id":{"type":"string"},"product_id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The storefront path.","type":"string"},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"subtitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"section":{"anyOf":[{"type":"string"},{"type":"null"}]},"author":{"description":"Who signs it, or null when unsigned.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"member"},"user":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["kind","user"]},{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["business","store"]}},"required":["kind"]},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"}},"preview":{"description":"The teaser, in the rich text format as stored.","anyOf":[{"type":"string"},{"type":"null"}],"x-rich-text":"text"},"position":{"type":"number"},"status":{"type":"string","x-extensible-enum":["draft","scheduled","published"]},"unlisted":{"type":"boolean"},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"unlisted_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"release":{"description":"When its content opens relative to one of its event's sessions, or null when it opens as published.","anyOf":[{"type":"object","properties":{"session":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"anchor":{"type":"string","x-extensible-enum":["start","end"]},"offset_minutes":{"type":"number"}},"required":["session","anchor","offset_minutes"]},{"type":"null"}]},"released_at":{"description":"Since when a write keeps its passed release open, so a later release no longer locks it; cleared with the release.","anyOf":[{"type":"string"},{"type":"null"}]},"search":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"ai_generated":{"description":"The description was machine-written, which readers are told.","type":"boolean"}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["summary","id","product_id","slug","path","url","title","subtitle","section","author","tags","preview","position","status","unlisted","published_at","unlisted_at","release","released_at","search","created_at","updated_at","settings","metadata"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"post":{"operationId":"createEntry","summary":"Creates a draft entry in a product.","tags":["entry"],"security":[{"bearer":["entry:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"201":{"description":"Creates a draft entry in a product.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"search":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["draft","scheduled","published"]},"id":{"type":"string"},"slug":{"type":"string"},"title":{"type":"string"},"subtitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"unlisted_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"ai_generated":{"description":"The description was machine-written, which readers are told.","type":"boolean"}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"unlisted":{"type":"boolean"},"section":{"anyOf":[{"type":"string"},{"type":"null"}]},"position":{"type":"number"},"in_use":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"count":{"type":"number"}},"required":["kind","count"]}},"product_id":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"released_at":{"description":"Since when a write keeps its passed release open, so a later release no longer locks it; cleared with the release.","anyOf":[{"type":"string"},{"type":"null"}]},"path":{"description":"The storefront path.","type":"string"},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one.","anyOf":[{"type":"string"},{"type":"null"}]},"release":{"description":"When its content opens relative to one of its event's sessions, or null when it opens as published.","anyOf":[{"type":"object","properties":{"session":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"anchor":{"type":"string","x-extensible-enum":["start","end"]},"offset_minutes":{"type":"number"}},"required":["session","anchor","offset_minutes"]},{"type":"null"}]},"access":{"type":"array","items":{"type":"object","properties":{"resource":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry","download","quiz","attachment","page"]},"id":{"type":"string"}},"required":["kind","id"]},"channel":{"type":"string","x-extensible-enum":["api","web","mcp","feed","any"]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"closed":{"type":"boolean"}},"required":["resource","channel","tier_id","closed"]}},"author":{"description":"Who signs it, or null when unsigned.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"member"},"user":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["kind","user"]},{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["business","store"]}},"required":["kind"]},{"type":"null"}]},"preview":{"description":"The teaser, in the rich text format as stored; answered only with `full`.","anyOf":[{"type":"string"},{"type":"null"}],"x-rich-text":"text"},"attachments":{"description":"Every attachment on the entry with its asset whole; answered only with `full`.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"target":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"}},"required":["kind","id"]},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"from_body":{"type":"boolean"},"release_file":{"description":"A file a software release ships, which its release edits and the product's own list leaves out.","type":"boolean"},"position":{"type":"number"},"asset":{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}},"required":["id","target","role","delivery","preview_only","from_body","release_file","position","asset"]}},"files":{"description":"The files its teaser names, and every other file it binds; answered only with `full`.","type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["video","audio","image","pdf","file"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes, null when it has none or is withheld.","anyOf":[{"type":"number"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"description":"Seconds.","anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"url":{"description":"A public file's lasting URL, an image's naming its widths' version as `#v=` once they're made; null for a private one, or one whose bytes haven't landed.","anyOf":[{"type":"string"},{"type":"null"}]},"resized":{"description":"A public image's smaller copies, narrowest first, for a `srcset`; left out until they're made and its width measured, for one kept as uploaded, and for any other file.","type":"array","items":{"type":"object","properties":{"width":{"description":"Its width in pixels, at most the image's own.","type":"integer","minimum":1},"avif":{"description":"A lasting URL to it as AVIF.","type":"string"},"webp":{"description":"A lasting URL to it as WebP.","type":"string"}},"required":["width","avif","webp"]}},"attachment_id":{"description":"The binding a private file opens through; null when the reader can't open it.","anyOf":[{"type":"string"},{"type":"null"}]},"unlocks":{"description":"What unlocks a file its own rules keep from the reader, any one; null for any other file.","anyOf":[{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product_name":{"type":"string"},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]}},"required":["product_id","product_name","tier"]}},{"type":"null"}]},"video":{"description":"A video's subtitles and published AI outputs, where its read lists any and the reader may play it.","type":"object","properties":{"attachment_id":{"type":"string"},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["attachment_id","tracks","outputs"]},"audio":{"description":"An audio file's waveform, subtitles and published AI outputs, where the reader may play it.","type":"object","properties":{"waveform":{"description":"256 levels from 0 to 255, base64, from the file's start to its end; null until drawn, or when it can't be.","anyOf":[{"type":"string"},{"type":"null"}]},"attachment_id":{"description":"The binding its tracks and outputs open through, which a public file carries here alone; null with none.","anyOf":[{"type":"string"},{"type":"null"}]},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["waveform","attachment_id","tracks","outputs"]}},"required":["id","kind","mime","name","bytes","width","height","duration","pages","status","url","attachment_id","unlocks"]}},"quizzes":{"description":"Its quiz versions, the current one first; answered only with `full`.","type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"entry_id":{"type":"string"},"product_id":{"type":"string"},"version":{"type":"number"},"settings":{"type":"object","properties":{"attempts_allowed":{"anyOf":[{"type":"number"},{"type":"null"}]},"pass_mark":{"anyOf":[{"type":"number"},{"type":"null"}]},"show_answers":{"type":"boolean"}},"required":["attempts_allowed","pass_mark","show_answers"]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","entry_id","product_id","version","settings","created_at","updated_at"]}},"total":{"type":"number"}},"required":["items","total"]},"created":{"description":"The attachments the write bound: the files a new teaser names.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string","x-extensible-enum":["prose","teaser","embed"]},"asset":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["id","role","asset"]}}},"required":["search","status","id","slug","title","subtitle","published_at","unlisted_at","created_at","updated_at","settings","metadata","unlisted","section","position","in_use","product_id","tags","released_at","path","url","release","access","author","created"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text_format":{"type":"string","enum":["html","markdown"],"default":"html","description":"The format the rich text fields are written in: the rich text format’s HTML, or Markdown converted into it before it is validated. A text already stored in the format (starting with `<rich-text`) is kept as it is either way."},"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true},"slug":{"description":"Made from the title when absent: its words, numbered past a twin under the product and the product's own routes, which a given one may not name either.","type":"string","minLength":1,"maxLength":120,"pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$"},"title":{"type":"string","minLength":1,"maxLength":200},"subtitle":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"section":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"author":{"description":"Who signs it; null leaves it unsigned. A new entry is signed by the member writing it, or by the store with no member behind the call.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"member"},"user":{"description":"A user holding a seat on the store's business now.","type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"required":["kind","user"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"business"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"store"}},"required":["kind"],"additionalProperties":false},{"type":"null"}]},"tags":{"description":"Labels the product's entries are listed by, in this order, none twice ignoring case: visible, well-formed text with no comma, its words parted by single plain spaces.","type":"array","items":{"type":"string","minLength":1,"maxLength":60,"pattern":"^[^\\s,\\u0000-\\u001f\\u007f-\\u009f]( ?[^\\s,\\u0000-\\u001f\\u007f-\\u009f])*$"},"maxItems":20},"unlisted":{"description":"Reachable by id or slug but out of the product's lists, the sitemap and notifications, and served noindex; the first unlist's stamp is kept.","type":"boolean"},"preview":{"description":"The teaser, a rich text with the blocks a lesson takes, stored in its canonical form in 16 KiB of UTF-8, an image it starts showing at most 15 MB; empty clears it.","anyOf":[{"type":"string","maxLength":4096},{"type":"null"}],"x-rich-text":"text"},"release":{"description":"An event entry's release relative to one of its sessions, its content locked to everyone until then; null opens it as published.","anyOf":[{"type":"object","properties":{"session":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"anchor":{"description":"Which end of the session the offset counts from.","type":"string","enum":["start","end"]},"offset_minutes":{"description":"Minutes from the anchor, negative before it, within 30 days.","type":"integer","minimum":-43200,"maximum":43200}},"required":["session","anchor","offset_minutes"],"additionalProperties":false},{"type":"null"}]},"settings":{"type":"object","properties":{"ai_generated":{"description":"The description was machine-written, which readers are told.","type":"boolean"}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"place":{"description":"After the last entry of its chapter, or past the product's last when the chapter has none; an update moves it only when its section changes.","type":"string","const":"chapter"},"new_section":{"description":"Refuse a section another chapter holds, so a new chapter never joins one by accident.","type":"boolean","const":true},"held_section":{"description":"Refuse a section no chapter holds as `not_found`, so a chapter renamed or removed meanwhile never comes back; no chapter always passes; not with `new_section`.","type":"boolean","const":true}},"required":["title"],"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/entries/details":{"get":{"operationId":"listEntryDetails","summary":"Pages a product's entries, each read whole, a blog's drafts first then newest first, a podcast's newest first, unless sorted.","tags":["entry"],"security":[{"bearer":["entry:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","description":"Sorted by published, rows without a value come last either way. Sorted by latest, rows without a value come first either way.","schema":{"type":"string","enum":["position","created","published","latest","title"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":50}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"search","in":"query","schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Pages a product's entries, each read whole, a blog's drafts first then newest first, a podcast's newest first, unless sorted.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"summary":{"type":"object","properties":{"poster":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]},{"type":"null"}]},"has_video":{"type":"boolean"},"duration":{"anyOf":[{"type":"number"},{"type":"null"}]},"presentations":{"type":"number"},"slides":{"type":"number"},"files":{"type":"number"},"links":{"type":"number"},"has_body":{"type":"boolean"},"has_quiz":{"type":"boolean"},"has_certificate":{"type":"boolean"}},"required":["poster","has_video","duration","presentations","slides","files","links","has_body","has_quiz","has_certificate"]},"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"target":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"}},"required":["kind","id"]},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"from_body":{"type":"boolean"},"release_file":{"description":"A file a software release ships, which its release edits and the product's own list leaves out.","type":"boolean"},"position":{"type":"number"},"asset":{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}},"required":["id","target","role","delivery","preview_only","from_body","release_file","position","asset"]}},"files":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["video","audio","image","pdf","file"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes, null when it has none or is withheld.","anyOf":[{"type":"number"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"description":"Seconds.","anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"url":{"description":"A public file's lasting URL, an image's naming its widths' version as `#v=` once they're made; null for a private one, or one whose bytes haven't landed.","anyOf":[{"type":"string"},{"type":"null"}]},"resized":{"description":"A public image's smaller copies, narrowest first, for a `srcset`; left out until they're made and its width measured, for one kept as uploaded, and for any other file.","type":"array","items":{"type":"object","properties":{"width":{"description":"Its width in pixels, at most the image's own.","type":"integer","minimum":1},"avif":{"description":"A lasting URL to it as AVIF.","type":"string"},"webp":{"description":"A lasting URL to it as WebP.","type":"string"}},"required":["width","avif","webp"]}},"attachment_id":{"description":"The binding a private file opens through; null when the reader can't open it.","anyOf":[{"type":"string"},{"type":"null"}]},"unlocks":{"description":"What unlocks a file its own rules keep from the reader, any one; null for any other file.","anyOf":[{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product_name":{"type":"string"},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]}},"required":["product_id","product_name","tier"]}},{"type":"null"}]},"video":{"description":"A video's subtitles and published AI outputs, where its read lists any and the reader may play it.","type":"object","properties":{"attachment_id":{"type":"string"},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["attachment_id","tracks","outputs"]},"audio":{"description":"An audio file's waveform, subtitles and published AI outputs, where the reader may play it.","type":"object","properties":{"waveform":{"description":"256 levels from 0 to 255, base64, from the file's start to its end; null until drawn, or when it can't be.","anyOf":[{"type":"string"},{"type":"null"}]},"attachment_id":{"description":"The binding its tracks and outputs open through, which a public file carries here alone; null with none.","anyOf":[{"type":"string"},{"type":"null"}]},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["waveform","attachment_id","tracks","outputs"]}},"required":["id","kind","mime","name","bytes","width","height","duration","pages","status","url","attachment_id","unlocks"]}},"access":{"type":"array","items":{"type":"object","properties":{"resource":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry","download","quiz","attachment","page"]},"id":{"type":"string"}},"required":["kind","id"]},"channel":{"type":"string","x-extensible-enum":["api","web","mcp","feed","any"]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"closed":{"type":"boolean"}},"required":["resource","channel","tier_id","closed"]}},"quizzes":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"entry_id":{"type":"string"},"product_id":{"type":"string"},"version":{"type":"number"},"settings":{"type":"object","properties":{"attempts_allowed":{"anyOf":[{"type":"number"},{"type":"null"}]},"pass_mark":{"anyOf":[{"type":"number"},{"type":"null"}]},"show_answers":{"type":"boolean"}},"required":["attempts_allowed","pass_mark","show_answers"]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","entry_id","product_id","version","settings","created_at","updated_at"]}},"total":{"type":"number"}},"required":["items","total"]},"in_use":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"count":{"type":"number"}},"required":["kind","count"]}},"id":{"type":"string"},"product_id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The storefront path.","type":"string"},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"subtitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"section":{"anyOf":[{"type":"string"},{"type":"null"}]},"author":{"description":"Who signs it, or null when unsigned.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"member"},"user":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["kind","user"]},{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["business","store"]}},"required":["kind"]},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"}},"preview":{"description":"The teaser, in the rich text format as stored.","anyOf":[{"type":"string"},{"type":"null"}],"x-rich-text":"text"},"position":{"type":"number"},"status":{"type":"string","x-extensible-enum":["draft","scheduled","published"]},"unlisted":{"type":"boolean"},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"unlisted_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"release":{"description":"When its content opens relative to one of its event's sessions, or null when it opens as published.","anyOf":[{"type":"object","properties":{"session":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"anchor":{"type":"string","x-extensible-enum":["start","end"]},"offset_minutes":{"type":"number"}},"required":["session","anchor","offset_minutes"]},{"type":"null"}]},"released_at":{"description":"Since when a write keeps its passed release open, so a later release no longer locks it; cleared with the release.","anyOf":[{"type":"string"},{"type":"null"}]},"search":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"ai_generated":{"description":"The description was machine-written, which readers are told.","type":"boolean"}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["summary","attachments","files","access","quizzes","in_use","id","product_id","slug","path","url","title","subtitle","section","author","tags","preview","position","status","unlisted","published_at","unlisted_at","release","released_at","search","created_at","updated_at","settings","metadata"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/entries/{entry}":{"get":{"operationId":"getEntry","summary":"Reads one entry.","tags":["entry"],"security":[{"bearer":["entry:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"entry","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Reads one entry.","content":{"application/json":{"schema":{"type":"object","properties":{"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"target":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"}},"required":["kind","id"]},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"from_body":{"type":"boolean"},"release_file":{"description":"A file a software release ships, which its release edits and the product's own list leaves out.","type":"boolean"},"position":{"type":"number"},"asset":{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}},"required":["id","target","role","delivery","preview_only","from_body","release_file","position","asset"]}},"files":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["video","audio","image","pdf","file"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes, null when it has none or is withheld.","anyOf":[{"type":"number"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"description":"Seconds.","anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"url":{"description":"A public file's lasting URL, an image's naming its widths' version as `#v=` once they're made; null for a private one, or one whose bytes haven't landed.","anyOf":[{"type":"string"},{"type":"null"}]},"resized":{"description":"A public image's smaller copies, narrowest first, for a `srcset`; left out until they're made and its width measured, for one kept as uploaded, and for any other file.","type":"array","items":{"type":"object","properties":{"width":{"description":"Its width in pixels, at most the image's own.","type":"integer","minimum":1},"avif":{"description":"A lasting URL to it as AVIF.","type":"string"},"webp":{"description":"A lasting URL to it as WebP.","type":"string"}},"required":["width","avif","webp"]}},"attachment_id":{"description":"The binding a private file opens through; null when the reader can't open it.","anyOf":[{"type":"string"},{"type":"null"}]},"unlocks":{"description":"What unlocks a file its own rules keep from the reader, any one; null for any other file.","anyOf":[{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product_name":{"type":"string"},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]}},"required":["product_id","product_name","tier"]}},{"type":"null"}]},"video":{"description":"A video's subtitles and published AI outputs, where its read lists any and the reader may play it.","type":"object","properties":{"attachment_id":{"type":"string"},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["attachment_id","tracks","outputs"]},"audio":{"description":"An audio file's waveform, subtitles and published AI outputs, where the reader may play it.","type":"object","properties":{"waveform":{"description":"256 levels from 0 to 255, base64, from the file's start to its end; null until drawn, or when it can't be.","anyOf":[{"type":"string"},{"type":"null"}]},"attachment_id":{"description":"The binding its tracks and outputs open through, which a public file carries here alone; null with none.","anyOf":[{"type":"string"},{"type":"null"}]},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["waveform","attachment_id","tracks","outputs"]}},"required":["id","kind","mime","name","bytes","width","height","duration","pages","status","url","attachment_id","unlocks"]}},"access":{"type":"array","items":{"type":"object","properties":{"resource":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry","download","quiz","attachment","page"]},"id":{"type":"string"}},"required":["kind","id"]},"channel":{"type":"string","x-extensible-enum":["api","web","mcp","feed","any"]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"closed":{"type":"boolean"}},"required":["resource","channel","tier_id","closed"]}},"quizzes":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"entry_id":{"type":"string"},"product_id":{"type":"string"},"version":{"type":"number"},"settings":{"type":"object","properties":{"attempts_allowed":{"anyOf":[{"type":"number"},{"type":"null"}]},"pass_mark":{"anyOf":[{"type":"number"},{"type":"null"}]},"show_answers":{"type":"boolean"}},"required":["attempts_allowed","pass_mark","show_answers"]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","entry_id","product_id","version","settings","created_at","updated_at"]}},"total":{"type":"number"}},"required":["items","total"]},"in_use":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"count":{"type":"number"}},"required":["kind","count"]}},"id":{"type":"string"},"product_id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The storefront path.","type":"string"},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"subtitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"section":{"anyOf":[{"type":"string"},{"type":"null"}]},"author":{"description":"Who signs it, or null when unsigned.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"member"},"user":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["kind","user"]},{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["business","store"]}},"required":["kind"]},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"}},"preview":{"description":"The teaser, in the rich text format as stored.","anyOf":[{"type":"string"},{"type":"null"}],"x-rich-text":"text"},"position":{"type":"number"},"status":{"type":"string","x-extensible-enum":["draft","scheduled","published"]},"unlisted":{"type":"boolean"},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"unlisted_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"release":{"description":"When its content opens relative to one of its event's sessions, or null when it opens as published.","anyOf":[{"type":"object","properties":{"session":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"anchor":{"type":"string","x-extensible-enum":["start","end"]},"offset_minutes":{"type":"number"}},"required":["session","anchor","offset_minutes"]},{"type":"null"}]},"released_at":{"description":"Since when a write keeps its passed release open, so a later release no longer locks it; cleared with the release.","anyOf":[{"type":"string"},{"type":"null"}]},"search":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"ai_generated":{"description":"The description was machine-written, which readers are told.","type":"boolean"}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["attachments","files","access","quizzes","in_use","id","product_id","slug","path","url","title","subtitle","section","author","tags","preview","position","status","unlisted","published_at","unlisted_at","release","released_at","search","created_at","updated_at","settings","metadata"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"patch":{"operationId":"updateEntry","summary":"Updates an entry's fields.","tags":["entry"],"security":[{"bearer":["entry:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"entry","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Updates an entry's fields.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"search":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["draft","scheduled","published"]},"id":{"type":"string"},"slug":{"type":"string"},"title":{"type":"string"},"subtitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"unlisted_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"ai_generated":{"description":"The description was machine-written, which readers are told.","type":"boolean"}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"unlisted":{"type":"boolean"},"section":{"anyOf":[{"type":"string"},{"type":"null"}]},"position":{"type":"number"},"in_use":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"count":{"type":"number"}},"required":["kind","count"]}},"product_id":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"released_at":{"description":"Since when a write keeps its passed release open, so a later release no longer locks it; cleared with the release.","anyOf":[{"type":"string"},{"type":"null"}]},"path":{"description":"The storefront path.","type":"string"},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one.","anyOf":[{"type":"string"},{"type":"null"}]},"release":{"description":"When its content opens relative to one of its event's sessions, or null when it opens as published.","anyOf":[{"type":"object","properties":{"session":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"anchor":{"type":"string","x-extensible-enum":["start","end"]},"offset_minutes":{"type":"number"}},"required":["session","anchor","offset_minutes"]},{"type":"null"}]},"access":{"type":"array","items":{"type":"object","properties":{"resource":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry","download","quiz","attachment","page"]},"id":{"type":"string"}},"required":["kind","id"]},"channel":{"type":"string","x-extensible-enum":["api","web","mcp","feed","any"]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"closed":{"type":"boolean"}},"required":["resource","channel","tier_id","closed"]}},"author":{"description":"Who signs it, or null when unsigned.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"member"},"user":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["kind","user"]},{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["business","store"]}},"required":["kind"]},{"type":"null"}]},"preview":{"description":"The teaser, in the rich text format as stored; answered only with `full`.","anyOf":[{"type":"string"},{"type":"null"}],"x-rich-text":"text"},"attachments":{"description":"Every attachment on the entry with its asset whole; answered only with `full`.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"target":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"}},"required":["kind","id"]},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"from_body":{"type":"boolean"},"release_file":{"description":"A file a software release ships, which its release edits and the product's own list leaves out.","type":"boolean"},"position":{"type":"number"},"asset":{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}},"required":["id","target","role","delivery","preview_only","from_body","release_file","position","asset"]}},"files":{"description":"The files its teaser names, and every other file it binds; answered only with `full`.","type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["video","audio","image","pdf","file"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes, null when it has none or is withheld.","anyOf":[{"type":"number"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"description":"Seconds.","anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"url":{"description":"A public file's lasting URL, an image's naming its widths' version as `#v=` once they're made; null for a private one, or one whose bytes haven't landed.","anyOf":[{"type":"string"},{"type":"null"}]},"resized":{"description":"A public image's smaller copies, narrowest first, for a `srcset`; left out until they're made and its width measured, for one kept as uploaded, and for any other file.","type":"array","items":{"type":"object","properties":{"width":{"description":"Its width in pixels, at most the image's own.","type":"integer","minimum":1},"avif":{"description":"A lasting URL to it as AVIF.","type":"string"},"webp":{"description":"A lasting URL to it as WebP.","type":"string"}},"required":["width","avif","webp"]}},"attachment_id":{"description":"The binding a private file opens through; null when the reader can't open it.","anyOf":[{"type":"string"},{"type":"null"}]},"unlocks":{"description":"What unlocks a file its own rules keep from the reader, any one; null for any other file.","anyOf":[{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product_name":{"type":"string"},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]}},"required":["product_id","product_name","tier"]}},{"type":"null"}]},"video":{"description":"A video's subtitles and published AI outputs, where its read lists any and the reader may play it.","type":"object","properties":{"attachment_id":{"type":"string"},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["attachment_id","tracks","outputs"]},"audio":{"description":"An audio file's waveform, subtitles and published AI outputs, where the reader may play it.","type":"object","properties":{"waveform":{"description":"256 levels from 0 to 255, base64, from the file's start to its end; null until drawn, or when it can't be.","anyOf":[{"type":"string"},{"type":"null"}]},"attachment_id":{"description":"The binding its tracks and outputs open through, which a public file carries here alone; null with none.","anyOf":[{"type":"string"},{"type":"null"}]},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["waveform","attachment_id","tracks","outputs"]}},"required":["id","kind","mime","name","bytes","width","height","duration","pages","status","url","attachment_id","unlocks"]}},"quizzes":{"description":"Its quiz versions, the current one first; answered only with `full`.","type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"entry_id":{"type":"string"},"product_id":{"type":"string"},"version":{"type":"number"},"settings":{"type":"object","properties":{"attempts_allowed":{"anyOf":[{"type":"number"},{"type":"null"}]},"pass_mark":{"anyOf":[{"type":"number"},{"type":"null"}]},"show_answers":{"type":"boolean"}},"required":["attempts_allowed","pass_mark","show_answers"]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","entry_id","product_id","version","settings","created_at","updated_at"]}},"total":{"type":"number"}},"required":["items","total"]},"created":{"description":"The attachments the write bound: the files a new teaser names.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string","x-extensible-enum":["prose","teaser","embed"]},"asset":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["id","role","asset"]}}},"required":["search","status","id","slug","title","subtitle","published_at","unlisted_at","created_at","updated_at","settings","metadata","unlisted","section","position","in_use","product_id","tags","released_at","path","url","release","access","author","created"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"text_format":{"type":"string","enum":["html","markdown"],"default":"html","description":"The format the rich text fields are written in: the rich text format’s HTML, or Markdown converted into it before it is validated. A text already stored in the format (starting with `<rich-text`) is kept as it is either way."},"title":{"type":"string","minLength":1,"maxLength":200},"subtitle":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"unlisted":{"description":"Reachable by id or slug but out of the product's lists, the sitemap and notifications, and served noindex; the first unlist's stamp is kept.","type":"boolean"},"section":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"preview":{"description":"The teaser, a rich text with the blocks a lesson takes, stored in its canonical form in 16 KiB of UTF-8, an image it starts showing at most 15 MB; empty clears it.","anyOf":[{"type":"string","maxLength":4096},{"type":"null"}],"x-rich-text":"text"},"tags":{"description":"Labels the product's entries are listed by, in this order, none twice ignoring case: visible, well-formed text with no comma, its words parted by single plain spaces.","type":"array","items":{"type":"string","minLength":1,"maxLength":60,"pattern":"^[^\\s,\\u0000-\\u001f\\u007f-\\u009f]( ?[^\\s,\\u0000-\\u001f\\u007f-\\u009f])*$"},"maxItems":20},"release":{"description":"An event entry's release relative to one of its sessions, its content locked to everyone until then; null opens it as published.","anyOf":[{"type":"object","properties":{"session":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"anchor":{"description":"Which end of the session the offset counts from.","type":"string","enum":["start","end"]},"offset_minutes":{"description":"Minutes from the anchor, negative before it, within 30 days.","type":"integer","minimum":-43200,"maximum":43200}},"required":["session","anchor","offset_minutes"],"additionalProperties":false},{"type":"null"}]},"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true},"author":{"description":"Who signs it; null leaves it unsigned. A new entry is signed by the member writing it, or by the store with no member behind the call.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"member"},"user":{"description":"A user holding a seat on the store's business now.","type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"required":["kind","user"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"business"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"store"}},"required":["kind"],"additionalProperties":false},{"type":"null"}]},"place":{"description":"After the last entry of its chapter, or past the product's last when the chapter has none; an update moves it only when its section changes.","type":"string","const":"chapter"},"new_section":{"description":"Refuse a section another chapter holds, so a new chapter never joins one by accident.","type":"boolean","const":true},"held_section":{"description":"Refuse a section no chapter holds as `not_found`, so a chapter renamed or removed meanwhile never comes back; no chapter always passes; not with `new_section`.","type":"boolean","const":true},"settings":{"description":"Merged onto the stored settings; null deletes a key.","type":"object","properties":{"ai_generated":{"description":"The description was machine-written, which readers are told.","anyOf":[{"type":"boolean"},{"type":"null"}]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"from":{"description":"The fields the caller read; one holding another value now refuses.","type":"object","properties":{"title":{"type":"string"},"subtitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"section":{"anyOf":[{"type":"string"},{"type":"null"}]},"author":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"member"},"user":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"additionalProperties":false}},"required":["kind","user"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"business"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"store"}},"required":["kind"],"additionalProperties":false},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"}},"unlisted":{"type":"boolean"},"preview":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"description":"An entry without `ai_generated` holds false.","type":"object","properties":{"ai_generated":{"type":"boolean"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false}}}}},"delete":{"operationId":"deleteEntry","summary":"Deletes an entry.","tags":["entry"],"security":[{"bearer":["entry:delete"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"entry","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"discard_progress","in":"query","description":"Lets what customers did in it (completions, quiz sittings) and its notifications go with it; needs `customer:write` and `organization:write`.","schema":{"description":"Lets what customers did in it (completions, quiz sittings) and its notifications go with it; needs `customer:write` and `organization:write`.","type":"boolean","const":true}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Deletes an entry.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean","const":true}},"required":["id","deleted"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/entries/stats":{"get":{"operationId":"entryStats","summary":"Counts a product's entries by status and section.","tags":["entry"],"security":[{"bearer":["entry:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Counts a product's entries by status and section.","content":{"application/json":{"schema":{"type":"object","properties":{"students":{"type":"number"},"average_completion":{"anyOf":[{"type":"number"},{"type":"null"}]},"entries":{"type":"array","items":{"type":"object","properties":{"entry_id":{"type":"string"},"completions":{"type":"number"},"completed_fraction":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["entry_id","completions","completed_fraction"]}}},"required":["students","average_completion","entries"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/entries/{entry}/publish":{"post":{"operationId":"publishEntry","summary":"Publishes an entry now or schedules it.","tags":["entry"],"security":[{"bearer":["entry:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"entry","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Publishes an entry now or schedules it.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"search":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["draft","scheduled","published"]},"id":{"type":"string"},"slug":{"type":"string"},"title":{"type":"string"},"subtitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"unlisted_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"ai_generated":{"description":"The description was machine-written, which readers are told.","type":"boolean"}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"unlisted":{"type":"boolean"},"section":{"anyOf":[{"type":"string"},{"type":"null"}]},"position":{"type":"number"},"in_use":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"count":{"type":"number"}},"required":["kind","count"]}},"product_id":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"released_at":{"description":"Since when a write keeps its passed release open, so a later release no longer locks it; cleared with the release.","anyOf":[{"type":"string"},{"type":"null"}]},"path":{"description":"The storefront path.","type":"string"},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one.","anyOf":[{"type":"string"},{"type":"null"}]},"release":{"description":"When its content opens relative to one of its event's sessions, or null when it opens as published.","anyOf":[{"type":"object","properties":{"session":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"anchor":{"type":"string","x-extensible-enum":["start","end"]},"offset_minutes":{"type":"number"}},"required":["session","anchor","offset_minutes"]},{"type":"null"}]},"access":{"type":"array","items":{"type":"object","properties":{"resource":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry","download","quiz","attachment","page"]},"id":{"type":"string"}},"required":["kind","id"]},"channel":{"type":"string","x-extensible-enum":["api","web","mcp","feed","any"]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"closed":{"type":"boolean"}},"required":["resource","channel","tier_id","closed"]}},"author":{"description":"Who signs it, or null when unsigned.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"member"},"user":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["kind","user"]},{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["business","store"]}},"required":["kind"]},{"type":"null"}]},"preview":{"description":"The teaser, in the rich text format as stored; answered only with `full`.","anyOf":[{"type":"string"},{"type":"null"}],"x-rich-text":"text"},"attachments":{"description":"Every attachment on the entry with its asset whole; answered only with `full`.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"target":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"}},"required":["kind","id"]},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"from_body":{"type":"boolean"},"release_file":{"description":"A file a software release ships, which its release edits and the product's own list leaves out.","type":"boolean"},"position":{"type":"number"},"asset":{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}},"required":["id","target","role","delivery","preview_only","from_body","release_file","position","asset"]}},"files":{"description":"The files its teaser names, and every other file it binds; answered only with `full`.","type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["video","audio","image","pdf","file"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes, null when it has none or is withheld.","anyOf":[{"type":"number"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"description":"Seconds.","anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"url":{"description":"A public file's lasting URL, an image's naming its widths' version as `#v=` once they're made; null for a private one, or one whose bytes haven't landed.","anyOf":[{"type":"string"},{"type":"null"}]},"resized":{"description":"A public image's smaller copies, narrowest first, for a `srcset`; left out until they're made and its width measured, for one kept as uploaded, and for any other file.","type":"array","items":{"type":"object","properties":{"width":{"description":"Its width in pixels, at most the image's own.","type":"integer","minimum":1},"avif":{"description":"A lasting URL to it as AVIF.","type":"string"},"webp":{"description":"A lasting URL to it as WebP.","type":"string"}},"required":["width","avif","webp"]}},"attachment_id":{"description":"The binding a private file opens through; null when the reader can't open it.","anyOf":[{"type":"string"},{"type":"null"}]},"unlocks":{"description":"What unlocks a file its own rules keep from the reader, any one; null for any other file.","anyOf":[{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product_name":{"type":"string"},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]}},"required":["product_id","product_name","tier"]}},{"type":"null"}]},"video":{"description":"A video's subtitles and published AI outputs, where its read lists any and the reader may play it.","type":"object","properties":{"attachment_id":{"type":"string"},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["attachment_id","tracks","outputs"]},"audio":{"description":"An audio file's waveform, subtitles and published AI outputs, where the reader may play it.","type":"object","properties":{"waveform":{"description":"256 levels from 0 to 255, base64, from the file's start to its end; null until drawn, or when it can't be.","anyOf":[{"type":"string"},{"type":"null"}]},"attachment_id":{"description":"The binding its tracks and outputs open through, which a public file carries here alone; null with none.","anyOf":[{"type":"string"},{"type":"null"}]},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["waveform","attachment_id","tracks","outputs"]}},"required":["id","kind","mime","name","bytes","width","height","duration","pages","status","url","attachment_id","unlocks"]}},"quizzes":{"description":"Its quiz versions, the current one first; answered only with `full`.","type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"entry_id":{"type":"string"},"product_id":{"type":"string"},"version":{"type":"number"},"settings":{"type":"object","properties":{"attempts_allowed":{"anyOf":[{"type":"number"},{"type":"null"}]},"pass_mark":{"anyOf":[{"type":"number"},{"type":"null"}]},"show_answers":{"type":"boolean"}},"required":["attempts_allowed","pass_mark","show_answers"]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","entry_id","product_id","version","settings","created_at","updated_at"]}},"total":{"type":"number"}},"required":["items","total"]},"created":{"description":"The attachments the write bound: the files a new teaser names.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string","x-extensible-enum":["prose","teaser","embed"]},"asset":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["id","role","asset"]}}},"required":["search","status","id","slug","title","subtitle","published_at","unlisted_at","created_at","updated_at","settings","metadata","unlisted","section","position","in_use","product_id","tags","released_at","path","url","release","access","author","created"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true},"at":{"type":"string","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})(?:T(\\d{2}):(\\d{2})(?::(\\d{2})(?:\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"},"expect":{"description":"The status the caller saw; one that moved meanwhile, as a post taken down elsewhere, refuses.","type":"string","enum":["draft","scheduled","published"]}},"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/entries/{entry}/unpublish":{"post":{"operationId":"unpublishEntry","summary":"Takes an entry back to draft.","tags":["entry"],"security":[{"bearer":["entry:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"entry","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Takes an entry back to draft.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"search":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["draft","scheduled","published"]},"id":{"type":"string"},"slug":{"type":"string"},"title":{"type":"string"},"subtitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"unlisted_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"ai_generated":{"description":"The description was machine-written, which readers are told.","type":"boolean"}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"unlisted":{"type":"boolean"},"section":{"anyOf":[{"type":"string"},{"type":"null"}]},"position":{"type":"number"},"in_use":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"count":{"type":"number"}},"required":["kind","count"]}},"product_id":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"released_at":{"description":"Since when a write keeps its passed release open, so a later release no longer locks it; cleared with the release.","anyOf":[{"type":"string"},{"type":"null"}]},"path":{"description":"The storefront path.","type":"string"},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one.","anyOf":[{"type":"string"},{"type":"null"}]},"release":{"description":"When its content opens relative to one of its event's sessions, or null when it opens as published.","anyOf":[{"type":"object","properties":{"session":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"anchor":{"type":"string","x-extensible-enum":["start","end"]},"offset_minutes":{"type":"number"}},"required":["session","anchor","offset_minutes"]},{"type":"null"}]},"access":{"type":"array","items":{"type":"object","properties":{"resource":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry","download","quiz","attachment","page"]},"id":{"type":"string"}},"required":["kind","id"]},"channel":{"type":"string","x-extensible-enum":["api","web","mcp","feed","any"]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"closed":{"type":"boolean"}},"required":["resource","channel","tier_id","closed"]}},"author":{"description":"Who signs it, or null when unsigned.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"member"},"user":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["kind","user"]},{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["business","store"]}},"required":["kind"]},{"type":"null"}]},"preview":{"description":"The teaser, in the rich text format as stored; answered only with `full`.","anyOf":[{"type":"string"},{"type":"null"}],"x-rich-text":"text"},"attachments":{"description":"Every attachment on the entry with its asset whole; answered only with `full`.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"target":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"}},"required":["kind","id"]},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"from_body":{"type":"boolean"},"release_file":{"description":"A file a software release ships, which its release edits and the product's own list leaves out.","type":"boolean"},"position":{"type":"number"},"asset":{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}},"required":["id","target","role","delivery","preview_only","from_body","release_file","position","asset"]}},"files":{"description":"The files its teaser names, and every other file it binds; answered only with `full`.","type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["video","audio","image","pdf","file"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes, null when it has none or is withheld.","anyOf":[{"type":"number"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"description":"Seconds.","anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"url":{"description":"A public file's lasting URL, an image's naming its widths' version as `#v=` once they're made; null for a private one, or one whose bytes haven't landed.","anyOf":[{"type":"string"},{"type":"null"}]},"resized":{"description":"A public image's smaller copies, narrowest first, for a `srcset`; left out until they're made and its width measured, for one kept as uploaded, and for any other file.","type":"array","items":{"type":"object","properties":{"width":{"description":"Its width in pixels, at most the image's own.","type":"integer","minimum":1},"avif":{"description":"A lasting URL to it as AVIF.","type":"string"},"webp":{"description":"A lasting URL to it as WebP.","type":"string"}},"required":["width","avif","webp"]}},"attachment_id":{"description":"The binding a private file opens through; null when the reader can't open it.","anyOf":[{"type":"string"},{"type":"null"}]},"unlocks":{"description":"What unlocks a file its own rules keep from the reader, any one; null for any other file.","anyOf":[{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product_name":{"type":"string"},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]}},"required":["product_id","product_name","tier"]}},{"type":"null"}]},"video":{"description":"A video's subtitles and published AI outputs, where its read lists any and the reader may play it.","type":"object","properties":{"attachment_id":{"type":"string"},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["attachment_id","tracks","outputs"]},"audio":{"description":"An audio file's waveform, subtitles and published AI outputs, where the reader may play it.","type":"object","properties":{"waveform":{"description":"256 levels from 0 to 255, base64, from the file's start to its end; null until drawn, or when it can't be.","anyOf":[{"type":"string"},{"type":"null"}]},"attachment_id":{"description":"The binding its tracks and outputs open through, which a public file carries here alone; null with none.","anyOf":[{"type":"string"},{"type":"null"}]},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["waveform","attachment_id","tracks","outputs"]}},"required":["id","kind","mime","name","bytes","width","height","duration","pages","status","url","attachment_id","unlocks"]}},"quizzes":{"description":"Its quiz versions, the current one first; answered only with `full`.","type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"entry_id":{"type":"string"},"product_id":{"type":"string"},"version":{"type":"number"},"settings":{"type":"object","properties":{"attempts_allowed":{"anyOf":[{"type":"number"},{"type":"null"}]},"pass_mark":{"anyOf":[{"type":"number"},{"type":"null"}]},"show_answers":{"type":"boolean"}},"required":["attempts_allowed","pass_mark","show_answers"]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","entry_id","product_id","version","settings","created_at","updated_at"]}},"total":{"type":"number"}},"required":["items","total"]},"created":{"description":"The attachments the write bound: the files a new teaser names.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string","x-extensible-enum":["prose","teaser","embed"]},"asset":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["id","role","asset"]}}},"required":["search","status","id","slug","title","subtitle","published_at","unlisted_at","created_at","updated_at","settings","metadata","unlisted","section","position","in_use","product_id","tags","released_at","path","url","release","access","author","created"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true}},"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/entries/reorder":{"post":{"operationId":"reorderEntries","summary":"Sets the order of a product's entries.","tags":["entry"],"security":[{"bearer":["entry:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Sets the order of a product's entries.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The storefront path.","type":"string"},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"subtitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"section":{"anyOf":[{"type":"string"},{"type":"null"}]},"author":{"description":"Who signs it, or null when unsigned.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"member"},"user":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["kind","user"]},{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["business","store"]}},"required":["kind"]},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"}},"preview":{"description":"The teaser, in the rich text format as stored.","anyOf":[{"type":"string"},{"type":"null"}],"x-rich-text":"text"},"position":{"type":"number"},"status":{"type":"string","x-extensible-enum":["draft","scheduled","published"]},"unlisted":{"type":"boolean"},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"unlisted_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"release":{"description":"When its content opens relative to one of its event's sessions, or null when it opens as published.","anyOf":[{"type":"object","properties":{"session":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"anchor":{"type":"string","x-extensible-enum":["start","end"]},"offset_minutes":{"type":"number"}},"required":["session","anchor","offset_minutes"]},{"type":"null"}]},"released_at":{"description":"Since when a write keeps its passed release open, so a later release no longer locks it; cleared with the release.","anyOf":[{"type":"string"},{"type":"null"}]},"search":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"ai_generated":{"description":"The description was machine-written, which readers are told.","type":"boolean"}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["id","product_id","slug","path","url","title","subtitle","section","author","tags","preview","position","status","unlisted","published_at","unlisted_at","release","released_at","search","created_at","updated_at","settings","metadata"]}}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"entries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"minItems":1},"expect":{"description":"The order the caller read; another order now refuses, so two moves never overwrite each other.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}}},"required":["entries"],"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/entries/sections":{"get":{"operationId":"listEntrySections","summary":"Pages the distinct sections a product's entries hold, with how many hold each.","tags":["entry"],"security":[{"bearer":["entry:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["value","entries"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"search","in":"query","schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Pages the distinct sections a product's entries hold, with how many hold each.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"entries":{"type":"number"}},"required":["value","entries"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/entries/tags":{"get":{"operationId":"listEntryTags","summary":"Pages the distinct tags a product's entries hold, with how many hold each.","tags":["entry"],"security":[{"bearer":["entry:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["value","entries"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"search","in":"query","schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Pages the distinct tags a product's entries hold, with how many hold each.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"entries":{"type":"number"}},"required":["value","entries"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/sections":{"get":{"operationId":"listSections","summary":"Lists a product's entry sections.","tags":["entry"],"security":[{"bearer":["entry:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Lists a product's entry sections.","content":{"application/json":{"schema":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"section":{"anyOf":[{"type":"string"},{"type":"null"}]},"entries":{"type":"number"},"id":{"type":"null"}},"required":["section","entries","id"]},{"type":"object","properties":{"section":{"type":"string"},"entries":{"type":"number"},"id":{"type":"string"}},"required":["section","entries","id"]}]}}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"post":{"operationId":"createSection","summary":"Adds an entry section to a product.","tags":["entry"],"security":[{"bearer":["entry:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"201":{"description":"Adds an entry section to a product.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"section":{"anyOf":[{"type":"string"},{"type":"null"}]},"entries":{"type":"number"},"id":{"type":"null"}},"required":["section","entries","id"]},{"type":"object","properties":{"section":{"type":"string"},"entries":{"type":"number"},"id":{"type":"string"}},"required":["section","entries","id"]}]}}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"section":{"type":"string","minLength":1,"maxLength":120}},"required":["section"],"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/sections/rename":{"post":{"operationId":"renameSection","summary":"Renames a product's entry section.","tags":["entry"],"security":[{"bearer":["entry:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Renames a product's entry section.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The storefront path.","type":"string"},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"subtitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"section":{"anyOf":[{"type":"string"},{"type":"null"}]},"author":{"description":"Who signs it, or null when unsigned.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"member"},"user":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["kind","user"]},{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["business","store"]}},"required":["kind"]},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"}},"preview":{"description":"The teaser, in the rich text format as stored.","anyOf":[{"type":"string"},{"type":"null"}],"x-rich-text":"text"},"position":{"type":"number"},"status":{"type":"string","x-extensible-enum":["draft","scheduled","published"]},"unlisted":{"type":"boolean"},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"unlisted_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"release":{"description":"When its content opens relative to one of its event's sessions, or null when it opens as published.","anyOf":[{"type":"object","properties":{"session":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"anchor":{"type":"string","x-extensible-enum":["start","end"]},"offset_minutes":{"type":"number"}},"required":["session","anchor","offset_minutes"]},{"type":"null"}]},"released_at":{"description":"Since when a write keeps its passed release open, so a later release no longer locks it; cleared with the release.","anyOf":[{"type":"string"},{"type":"null"}]},"search":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"ai_generated":{"description":"The description was machine-written, which readers are told.","type":"boolean"}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["id","product_id","slug","path","url","title","subtitle","section","author","tags","preview","position","status","unlisted","published_at","unlisted_at","release","released_at","search","created_at","updated_at","settings","metadata"]}}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"section":{"anyOf":[{"type":"string","minLength":1,"maxLength":120},{"type":"null"}]},"section_id":{"type":"string","minLength":1,"maxLength":64},"to":{"anyOf":[{"type":"string","minLength":1,"maxLength":120},{"type":"null"}]}},"required":["to"],"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/sections/remove":{"post":{"operationId":"removeSection","summary":"Removes a product's entry section, its entries kept outside any section.","tags":["entry"],"security":[{"bearer":["entry:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Removes a product's entry section, its entries kept outside any section.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The storefront path.","type":"string"},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"subtitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"section":{"anyOf":[{"type":"string"},{"type":"null"}]},"author":{"description":"Who signs it, or null when unsigned.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"member"},"user":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["kind","user"]},{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["business","store"]}},"required":["kind"]},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"}},"preview":{"description":"The teaser, in the rich text format as stored.","anyOf":[{"type":"string"},{"type":"null"}],"x-rich-text":"text"},"position":{"type":"number"},"status":{"type":"string","x-extensible-enum":["draft","scheduled","published"]},"unlisted":{"type":"boolean"},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"unlisted_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"release":{"description":"When its content opens relative to one of its event's sessions, or null when it opens as published.","anyOf":[{"type":"object","properties":{"session":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"anchor":{"type":"string","x-extensible-enum":["start","end"]},"offset_minutes":{"type":"number"}},"required":["session","anchor","offset_minutes"]},{"type":"null"}]},"released_at":{"description":"Since when a write keeps its passed release open, so a later release no longer locks it; cleared with the release.","anyOf":[{"type":"string"},{"type":"null"}]},"search":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"ai_generated":{"description":"The description was machine-written, which readers are told.","type":"boolean"}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["id","product_id","slug","path","url","title","subtitle","section","author","tags","preview","position","status","unlisted","published_at","unlisted_at","release","released_at","search","created_at","updated_at","settings","metadata"]}}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"section":{"anyOf":[{"type":"string","minLength":1,"maxLength":120},{"type":"null"}]},"section_id":{"type":"string","minLength":1,"maxLength":64},"into":{"description":"Where its entries go; absent for an empty chapter, refused once an entry took it.","anyOf":[{"type":"string","minLength":1,"maxLength":120},{"type":"null"}]}},"additionalProperties":false}}}}}},"/v1/stores/{store}/pages":{"get":{"operationId":"listPages","summary":"Pages the store's custom pages.","tags":["custompage"],"security":[{"bearer":["custompage:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["menu","created","title"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"search","in":"query","schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Pages the store's custom pages.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The storefront path.","type":"string"},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"menu_position":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["draft","scheduled","published"]},"live":{"description":"Served: published and within the pages the plan applies.","type":"boolean"},"menu_live":{"description":"Shown in the menu: published or scheduled, in it, and within the menu items the plan applies.","type":"boolean"},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"storefront":{"type":"object","properties":{"no_index":{"type":"boolean"}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["id","slug","path","url","title","description","menu_position","status","live","menu_live","published_at","created_at","updated_at","settings","metadata"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"post":{"operationId":"createPage","summary":"Creates a draft custom page.","tags":["custompage"],"security":[{"bearer":["custompage:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"201":{"description":"Creates a draft custom page.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","x-extensible-enum":["draft","scheduled","published"]},"id":{"type":"string"},"slug":{"type":"string"},"title":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"storefront":{"type":"object","properties":{"no_index":{"type":"boolean"}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"menu_position":{"anyOf":[{"type":"number"},{"type":"null"}]},"live":{"description":"Served: published and within the pages the plan applies.","type":"boolean"},"path":{"description":"The storefront path.","type":"string"},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one.","anyOf":[{"type":"string"},{"type":"null"}]},"menu_live":{"description":"Shown in the menu: published or scheduled, in it, and within the menu items the plan applies.","type":"boolean"},"access":{"type":"array","items":{"type":"object","properties":{"resource":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry","download","quiz","attachment","page"]},"id":{"type":"string"}},"required":["kind","id"]},"channel":{"type":"string","x-extensible-enum":["api","web","mcp","feed","any"]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"closed":{"type":"boolean"}},"required":["resource","channel","tier_id","closed"]}},"attachments":{"description":"Every attachment on the page with its asset whole; answered only with `full`.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"target":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"}},"required":["kind","id"]},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"from_body":{"type":"boolean"},"release_file":{"description":"A file a software release ships, which its release edits and the product's own list leaves out.","type":"boolean"},"position":{"type":"number"},"asset":{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}},"required":["id","target","role","delivery","preview_only","from_body","release_file","position","asset"]}},"files":{"description":"The files its body names; answered only with `full`.","type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["video","audio","image","pdf","file"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes, null when it has none or is withheld.","anyOf":[{"type":"number"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"description":"Seconds.","anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"url":{"description":"A public file's lasting URL, an image's naming its widths' version as `#v=` once they're made; null for a private one, or one whose bytes haven't landed.","anyOf":[{"type":"string"},{"type":"null"}]},"resized":{"description":"A public image's smaller copies, narrowest first, for a `srcset`; left out until they're made and its width measured, for one kept as uploaded, and for any other file.","type":"array","items":{"type":"object","properties":{"width":{"description":"Its width in pixels, at most the image's own.","type":"integer","minimum":1},"avif":{"description":"A lasting URL to it as AVIF.","type":"string"},"webp":{"description":"A lasting URL to it as WebP.","type":"string"}},"required":["width","avif","webp"]}},"attachment_id":{"description":"The binding a private file opens through; null when the reader can't open it.","anyOf":[{"type":"string"},{"type":"null"}]},"unlocks":{"description":"What unlocks a file its own rules keep from the reader, any one; null for any other file.","anyOf":[{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product_name":{"type":"string"},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]}},"required":["product_id","product_name","tier"]}},{"type":"null"}]},"video":{"description":"A video's subtitles and published AI outputs, where its read lists any and the reader may play it.","type":"object","properties":{"attachment_id":{"type":"string"},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["attachment_id","tracks","outputs"]},"audio":{"description":"An audio file's waveform, subtitles and published AI outputs, where the reader may play it.","type":"object","properties":{"waveform":{"description":"256 levels from 0 to 255, base64, from the file's start to its end; null until drawn, or when it can't be.","anyOf":[{"type":"string"},{"type":"null"}]},"attachment_id":{"description":"The binding its tracks and outputs open through, which a public file carries here alone; null with none.","anyOf":[{"type":"string"},{"type":"null"}]},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["waveform","attachment_id","tracks","outputs"]}},"required":["id","kind","mime","name","bytes","width","height","duration","pages","status","url","attachment_id","unlocks"]}}},"required":["status","id","slug","title","description","published_at","created_at","updated_at","settings","metadata","menu_position","live","path","url","menu_live","access"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true},"slug":{"description":"Made from the title when absent: its words, numbered past a twin.","type":"string","minLength":1,"maxLength":120,"pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$"},"title":{"type":"string","minLength":1,"maxLength":200},"description":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"menu_position":{"anyOf":[{"type":"integer","minimum":0,"maximum":1000000},{"type":"null"}]},"settings":{"type":"object","properties":{"storefront":{"type":"object","properties":{"no_index":{"type":"boolean"}},"additionalProperties":false}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["title"],"additionalProperties":false}}}}}},"/v1/stores/{store}/pages/{page}":{"get":{"operationId":"getPage","summary":"Reads one custom page.","tags":["custompage"],"security":[{"bearer":["custompage:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"page","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Reads one custom page.","content":{"application/json":{"schema":{"type":"object","properties":{"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"target":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"}},"required":["kind","id"]},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"from_body":{"type":"boolean"},"release_file":{"description":"A file a software release ships, which its release edits and the product's own list leaves out.","type":"boolean"},"position":{"type":"number"},"asset":{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}},"required":["id","target","role","delivery","preview_only","from_body","release_file","position","asset"]}},"files":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["video","audio","image","pdf","file"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes, null when it has none or is withheld.","anyOf":[{"type":"number"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"description":"Seconds.","anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"url":{"description":"A public file's lasting URL, an image's naming its widths' version as `#v=` once they're made; null for a private one, or one whose bytes haven't landed.","anyOf":[{"type":"string"},{"type":"null"}]},"resized":{"description":"A public image's smaller copies, narrowest first, for a `srcset`; left out until they're made and its width measured, for one kept as uploaded, and for any other file.","type":"array","items":{"type":"object","properties":{"width":{"description":"Its width in pixels, at most the image's own.","type":"integer","minimum":1},"avif":{"description":"A lasting URL to it as AVIF.","type":"string"},"webp":{"description":"A lasting URL to it as WebP.","type":"string"}},"required":["width","avif","webp"]}},"attachment_id":{"description":"The binding a private file opens through; null when the reader can't open it.","anyOf":[{"type":"string"},{"type":"null"}]},"unlocks":{"description":"What unlocks a file its own rules keep from the reader, any one; null for any other file.","anyOf":[{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product_name":{"type":"string"},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]}},"required":["product_id","product_name","tier"]}},{"type":"null"}]},"video":{"description":"A video's subtitles and published AI outputs, where its read lists any and the reader may play it.","type":"object","properties":{"attachment_id":{"type":"string"},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["attachment_id","tracks","outputs"]},"audio":{"description":"An audio file's waveform, subtitles and published AI outputs, where the reader may play it.","type":"object","properties":{"waveform":{"description":"256 levels from 0 to 255, base64, from the file's start to its end; null until drawn, or when it can't be.","anyOf":[{"type":"string"},{"type":"null"}]},"attachment_id":{"description":"The binding its tracks and outputs open through, which a public file carries here alone; null with none.","anyOf":[{"type":"string"},{"type":"null"}]},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["waveform","attachment_id","tracks","outputs"]}},"required":["id","kind","mime","name","bytes","width","height","duration","pages","status","url","attachment_id","unlocks"]}},"access":{"type":"array","items":{"type":"object","properties":{"resource":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry","download","quiz","attachment","page"]},"id":{"type":"string"}},"required":["kind","id"]},"channel":{"type":"string","x-extensible-enum":["api","web","mcp","feed","any"]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"closed":{"type":"boolean"}},"required":["resource","channel","tier_id","closed"]}},"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The storefront path.","type":"string"},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"menu_position":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["draft","scheduled","published"]},"live":{"description":"Served: published and within the pages the plan applies.","type":"boolean"},"menu_live":{"description":"Shown in the menu: published or scheduled, in it, and within the menu items the plan applies.","type":"boolean"},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"storefront":{"type":"object","properties":{"no_index":{"type":"boolean"}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["attachments","files","access","id","slug","path","url","title","description","menu_position","status","live","menu_live","published_at","created_at","updated_at","settings","metadata"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"patch":{"operationId":"updatePage","summary":"Updates a custom page's fields.","tags":["custompage"],"security":[{"bearer":["custompage:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"page","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Updates a custom page's fields.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","x-extensible-enum":["draft","scheduled","published"]},"id":{"type":"string"},"slug":{"type":"string"},"title":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"storefront":{"type":"object","properties":{"no_index":{"type":"boolean"}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"menu_position":{"anyOf":[{"type":"number"},{"type":"null"}]},"live":{"description":"Served: published and within the pages the plan applies.","type":"boolean"},"path":{"description":"The storefront path.","type":"string"},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one.","anyOf":[{"type":"string"},{"type":"null"}]},"menu_live":{"description":"Shown in the menu: published or scheduled, in it, and within the menu items the plan applies.","type":"boolean"},"access":{"type":"array","items":{"type":"object","properties":{"resource":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry","download","quiz","attachment","page"]},"id":{"type":"string"}},"required":["kind","id"]},"channel":{"type":"string","x-extensible-enum":["api","web","mcp","feed","any"]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"closed":{"type":"boolean"}},"required":["resource","channel","tier_id","closed"]}},"attachments":{"description":"Every attachment on the page with its asset whole; answered only with `full`.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"target":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"}},"required":["kind","id"]},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"from_body":{"type":"boolean"},"release_file":{"description":"A file a software release ships, which its release edits and the product's own list leaves out.","type":"boolean"},"position":{"type":"number"},"asset":{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}},"required":["id","target","role","delivery","preview_only","from_body","release_file","position","asset"]}},"files":{"description":"The files its body names; answered only with `full`.","type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["video","audio","image","pdf","file"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes, null when it has none or is withheld.","anyOf":[{"type":"number"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"description":"Seconds.","anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"url":{"description":"A public file's lasting URL, an image's naming its widths' version as `#v=` once they're made; null for a private one, or one whose bytes haven't landed.","anyOf":[{"type":"string"},{"type":"null"}]},"resized":{"description":"A public image's smaller copies, narrowest first, for a `srcset`; left out until they're made and its width measured, for one kept as uploaded, and for any other file.","type":"array","items":{"type":"object","properties":{"width":{"description":"Its width in pixels, at most the image's own.","type":"integer","minimum":1},"avif":{"description":"A lasting URL to it as AVIF.","type":"string"},"webp":{"description":"A lasting URL to it as WebP.","type":"string"}},"required":["width","avif","webp"]}},"attachment_id":{"description":"The binding a private file opens through; null when the reader can't open it.","anyOf":[{"type":"string"},{"type":"null"}]},"unlocks":{"description":"What unlocks a file its own rules keep from the reader, any one; null for any other file.","anyOf":[{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product_name":{"type":"string"},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]}},"required":["product_id","product_name","tier"]}},{"type":"null"}]},"video":{"description":"A video's subtitles and published AI outputs, where its read lists any and the reader may play it.","type":"object","properties":{"attachment_id":{"type":"string"},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["attachment_id","tracks","outputs"]},"audio":{"description":"An audio file's waveform, subtitles and published AI outputs, where the reader may play it.","type":"object","properties":{"waveform":{"description":"256 levels from 0 to 255, base64, from the file's start to its end; null until drawn, or when it can't be.","anyOf":[{"type":"string"},{"type":"null"}]},"attachment_id":{"description":"The binding its tracks and outputs open through, which a public file carries here alone; null with none.","anyOf":[{"type":"string"},{"type":"null"}]},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["waveform","attachment_id","tracks","outputs"]}},"required":["id","kind","mime","name","bytes","width","height","duration","pages","status","url","attachment_id","unlocks"]}}},"required":["status","id","slug","title","description","published_at","created_at","updated_at","settings","metadata","menu_position","live","path","url","menu_live","access"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"description":"Made from the title when absent: its words, numbered past a twin.","type":"string","minLength":1,"maxLength":120,"pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$"},"title":{"type":"string","minLength":1,"maxLength":200},"description":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"menu_position":{"anyOf":[{"type":"integer","minimum":0,"maximum":1000000},{"type":"null"}]},"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true},"settings":{"description":"Merged onto the stored settings; null deletes a key.","type":"object","properties":{"storefront":{"anyOf":[{"type":"object","properties":{"no_index":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"additionalProperties":false}}}}},"delete":{"operationId":"deletePage","summary":"Deletes a custom page.","tags":["custompage"],"security":[{"bearer":["custompage:delete"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"page","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Deletes a custom page.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean","const":true}},"required":["id","deleted"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/pages/{page}/publish":{"post":{"operationId":"publishPage","summary":"Publishes a custom page now or schedules it.","tags":["custompage"],"security":[{"bearer":["custompage:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"page","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Publishes a custom page now or schedules it.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","x-extensible-enum":["draft","scheduled","published"]},"id":{"type":"string"},"slug":{"type":"string"},"title":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"storefront":{"type":"object","properties":{"no_index":{"type":"boolean"}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"menu_position":{"anyOf":[{"type":"number"},{"type":"null"}]},"live":{"description":"Served: published and within the pages the plan applies.","type":"boolean"},"path":{"description":"The storefront path.","type":"string"},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one.","anyOf":[{"type":"string"},{"type":"null"}]},"menu_live":{"description":"Shown in the menu: published or scheduled, in it, and within the menu items the plan applies.","type":"boolean"},"access":{"type":"array","items":{"type":"object","properties":{"resource":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry","download","quiz","attachment","page"]},"id":{"type":"string"}},"required":["kind","id"]},"channel":{"type":"string","x-extensible-enum":["api","web","mcp","feed","any"]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"closed":{"type":"boolean"}},"required":["resource","channel","tier_id","closed"]}},"attachments":{"description":"Every attachment on the page with its asset whole; answered only with `full`.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"target":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"}},"required":["kind","id"]},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"from_body":{"type":"boolean"},"release_file":{"description":"A file a software release ships, which its release edits and the product's own list leaves out.","type":"boolean"},"position":{"type":"number"},"asset":{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}},"required":["id","target","role","delivery","preview_only","from_body","release_file","position","asset"]}},"files":{"description":"The files its body names; answered only with `full`.","type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["video","audio","image","pdf","file"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes, null when it has none or is withheld.","anyOf":[{"type":"number"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"description":"Seconds.","anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"url":{"description":"A public file's lasting URL, an image's naming its widths' version as `#v=` once they're made; null for a private one, or one whose bytes haven't landed.","anyOf":[{"type":"string"},{"type":"null"}]},"resized":{"description":"A public image's smaller copies, narrowest first, for a `srcset`; left out until they're made and its width measured, for one kept as uploaded, and for any other file.","type":"array","items":{"type":"object","properties":{"width":{"description":"Its width in pixels, at most the image's own.","type":"integer","minimum":1},"avif":{"description":"A lasting URL to it as AVIF.","type":"string"},"webp":{"description":"A lasting URL to it as WebP.","type":"string"}},"required":["width","avif","webp"]}},"attachment_id":{"description":"The binding a private file opens through; null when the reader can't open it.","anyOf":[{"type":"string"},{"type":"null"}]},"unlocks":{"description":"What unlocks a file its own rules keep from the reader, any one; null for any other file.","anyOf":[{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product_name":{"type":"string"},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]}},"required":["product_id","product_name","tier"]}},{"type":"null"}]},"video":{"description":"A video's subtitles and published AI outputs, where its read lists any and the reader may play it.","type":"object","properties":{"attachment_id":{"type":"string"},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["attachment_id","tracks","outputs"]},"audio":{"description":"An audio file's waveform, subtitles and published AI outputs, where the reader may play it.","type":"object","properties":{"waveform":{"description":"256 levels from 0 to 255, base64, from the file's start to its end; null until drawn, or when it can't be.","anyOf":[{"type":"string"},{"type":"null"}]},"attachment_id":{"description":"The binding its tracks and outputs open through, which a public file carries here alone; null with none.","anyOf":[{"type":"string"},{"type":"null"}]},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["waveform","attachment_id","tracks","outputs"]}},"required":["id","kind","mime","name","bytes","width","height","duration","pages","status","url","attachment_id","unlocks"]}}},"required":["status","id","slug","title","description","published_at","created_at","updated_at","settings","metadata","menu_position","live","path","url","menu_live","access"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true},"at":{"type":"string","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})(?:T(\\d{2}):(\\d{2})(?::(\\d{2})(?:\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"}},"additionalProperties":false}}}}}},"/v1/stores/{store}/pages/{page}/unpublish":{"post":{"operationId":"unpublishPage","summary":"Takes a custom page back to draft.","tags":["custompage"],"security":[{"bearer":["custompage:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"page","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Takes a custom page back to draft.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","x-extensible-enum":["draft","scheduled","published"]},"id":{"type":"string"},"slug":{"type":"string"},"title":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"storefront":{"type":"object","properties":{"no_index":{"type":"boolean"}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"menu_position":{"anyOf":[{"type":"number"},{"type":"null"}]},"live":{"description":"Served: published and within the pages the plan applies.","type":"boolean"},"path":{"description":"The storefront path.","type":"string"},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one.","anyOf":[{"type":"string"},{"type":"null"}]},"menu_live":{"description":"Shown in the menu: published or scheduled, in it, and within the menu items the plan applies.","type":"boolean"},"access":{"type":"array","items":{"type":"object","properties":{"resource":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry","download","quiz","attachment","page"]},"id":{"type":"string"}},"required":["kind","id"]},"channel":{"type":"string","x-extensible-enum":["api","web","mcp","feed","any"]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"closed":{"type":"boolean"}},"required":["resource","channel","tier_id","closed"]}},"attachments":{"description":"Every attachment on the page with its asset whole; answered only with `full`.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"target":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"}},"required":["kind","id"]},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"from_body":{"type":"boolean"},"release_file":{"description":"A file a software release ships, which its release edits and the product's own list leaves out.","type":"boolean"},"position":{"type":"number"},"asset":{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}},"required":["id","target","role","delivery","preview_only","from_body","release_file","position","asset"]}},"files":{"description":"The files its body names; answered only with `full`.","type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["video","audio","image","pdf","file"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes, null when it has none or is withheld.","anyOf":[{"type":"number"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"description":"Seconds.","anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"url":{"description":"A public file's lasting URL, an image's naming its widths' version as `#v=` once they're made; null for a private one, or one whose bytes haven't landed.","anyOf":[{"type":"string"},{"type":"null"}]},"resized":{"description":"A public image's smaller copies, narrowest first, for a `srcset`; left out until they're made and its width measured, for one kept as uploaded, and for any other file.","type":"array","items":{"type":"object","properties":{"width":{"description":"Its width in pixels, at most the image's own.","type":"integer","minimum":1},"avif":{"description":"A lasting URL to it as AVIF.","type":"string"},"webp":{"description":"A lasting URL to it as WebP.","type":"string"}},"required":["width","avif","webp"]}},"attachment_id":{"description":"The binding a private file opens through; null when the reader can't open it.","anyOf":[{"type":"string"},{"type":"null"}]},"unlocks":{"description":"What unlocks a file its own rules keep from the reader, any one; null for any other file.","anyOf":[{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product_name":{"type":"string"},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]}},"required":["product_id","product_name","tier"]}},{"type":"null"}]},"video":{"description":"A video's subtitles and published AI outputs, where its read lists any and the reader may play it.","type":"object","properties":{"attachment_id":{"type":"string"},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["attachment_id","tracks","outputs"]},"audio":{"description":"An audio file's waveform, subtitles and published AI outputs, where the reader may play it.","type":"object","properties":{"waveform":{"description":"256 levels from 0 to 255, base64, from the file's start to its end; null until drawn, or when it can't be.","anyOf":[{"type":"string"},{"type":"null"}]},"attachment_id":{"description":"The binding its tracks and outputs open through, which a public file carries here alone; null with none.","anyOf":[{"type":"string"},{"type":"null"}]},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["waveform","attachment_id","tracks","outputs"]}},"required":["id","kind","mime","name","bytes","width","height","duration","pages","status","url","attachment_id","unlocks"]}}},"required":["status","id","slug","title","description","published_at","created_at","updated_at","settings","metadata","menu_position","live","path","url","menu_live","access"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true},"expect":{"description":"The status the caller saw; one that moved meanwhile, as a schedule that went live, refuses.","type":"string","enum":["scheduled","published"]}},"additionalProperties":false}}}}}},"/v1/stores/{store}/{kind}/{id}/attachments":{"get":{"operationId":"listAttachments","summary":"Lists the files attached to a resource.","tags":["file"],"security":[{"bearer":["file:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"kind","in":"path","required":true,"description":"The target's kind, in the plural.","schema":{"type":"string","minLength":1}},{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Lists the files attached to a resource.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"target":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"}},"required":["kind","id"]},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"from_body":{"type":"boolean"},"release_file":{"description":"A file a software release ships, which its release edits and the product's own list leaves out.","type":"boolean"},"position":{"type":"number"},"asset":{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}},"required":["id","target","role","delivery","preview_only","from_body","release_file","position","asset"]}}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"post":{"operationId":"attachAsset","summary":"Attaches a file to a resource in a role.","tags":["file"],"security":[{"bearer":["file:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"kind","in":"path","required":true,"description":"The target's kind, in the plural.","schema":{"type":"string","minLength":1}},{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Attaches a file to a resource in a role.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"target":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"}},"required":["kind","id"]},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"from_body":{"type":"boolean"},"release_file":{"description":"A file a software release ships, which its release edits and the product's own list leaves out.","type":"boolean"},"position":{"type":"number"},"asset":{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}},"required":["id","target","role","delivery","preview_only","from_body","release_file","position","asset"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"asset":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"role":{"description":"A `poster` takes an image only, a `logo` an image and a `stylesheet` CSS; a poster, and an image a product binds as `embed`, at most 15 MB. The store's home takes only `body` and `stylesheet`, one of each; its body binds the files it names.","type":"string","enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"position":{"type":"integer","minimum":0,"maximum":1000000},"if_none":{"description":"Refused when the target already holds one in this role.","type":"boolean"},"if_none_of":{"description":"Refused while the target holds a file of this kind in the role that its body didn't bind; the asset must be one, or it refuses `conflict` on `mime` with the reason.","type":"string","enum":["video","audio","pdf"]}},"required":["asset","role"],"additionalProperties":false}}}}}},"/v1/stores/{store}/body_schema":{"get":{"operationId":"getBodySchema","summary":"Answers what a save takes for a kind of body: its block types, each block's props with their types, values and limits, which are required, and where blocks may sit.","tags":["file"],"security":[{"bearer":["file:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"kind","in":"query","required":true,"description":"The kind of body: `store`, `page`, `product` (any product but an event or a portfolio), `event`, `portfolio`, `lesson` (an entry of any product but a blog or a podcast, a portfolio's posts included), `article` (a blog's or a podcast's entry) or `all`.","schema":{"description":"The kind of body: `store`, `page`, `product` (any product but an event or a portfolio), `event`, `portfolio`, `lesson` (an entry of any product but a blog or a podcast, a portfolio's posts included), `article` (a blog's or a podcast's entry) or `all`.","type":"string","enum":["product","store","event","all","page","portfolio","lesson","article"]}}],"responses":{"200":{"description":"Answers what a save takes for a kind of body: its block types, each block's props with their types, values and limits, which are required, and where blocks may sit.","content":{"application/json":{"schema":{"type":"object","properties":{"kinds":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","store","event","page","portfolio","lesson","article"]},"summary":{"type":"string"},"block_types":{"description":"The types it newly stores as its blocks, inside its containers too.","type":"array","items":{"type":"string"}},"text_block_types":{"description":"The types its texts (a markdown block's `content`, and those its blocks nest) newly hold as `<block>` elements.","type":"array","items":{"type":"string"}},"max_blocks":{"type":"number"},"max_container_depth":{"description":"How deep its containers nest, a text counting as a level; null where only the layout's nesting caps them.","anyOf":[{"type":"number"},{"type":"null"}]},"text_max_container_depth":{"description":"How deep containers nest in its texts' inline blocks.","type":"number"},"required":{"description":"The blocks a product of a category must show; `category` null for every category not listed.","type":"array","items":{"type":"object","properties":{"category":{"anyOf":[{"type":"string"},{"type":"null"}]},"types":{"type":"array","items":{"type":"string"}}},"required":["category","types"]}},"at_most":{"description":"The most of a type it shows.","type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"count":{"type":"number"}},"required":["type","count"]}},"rules":{"description":"Where blocks may sit and what the body holds as a whole.","type":"array","items":{"type":"string"}},"schema":{"description":"The layout a save takes, in JSON Schema draft 2020-12, as JSON text; answered for one kind, not for `all`.","type":"string"}},"required":["kind","summary","block_types","text_block_types","max_blocks","max_container_depth","text_max_container_depth","required","at_most","rules"]}},"blocks":{"description":"Every type a listed kind takes, in its body or its texts.","type":"array","items":{"type":"object","properties":{"type":{"type":"string","x-extensible-enum":["products","actions","video","audio","image","map","download","stats","logo-cloud","contact","timeline","hr","spacer","markdown","background-image","slideshow","youtube","formula","diagram","line-products","grid-products","product-card","product-get","product-pages","product-content","product-summary","product-description","product-what-you-get","product-review","event-date","event-location","event-details","event-list","article-list","article-search","portfolio-chart","portfolio-stats","portfolio-activity","portfolio-holdings","portfolio-watchlist","portfolio-weights","hero","faq","card","carousel","pricing","side-by-side","grid","titled-section","theme-aware","aside","expandable"]},"summary":{"type":"string"},"container":{"type":"boolean"},"props":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"types":{"description":"The JSON types it takes.","type":"array","items":{"type":"string","x-extensible-enum":["string","number","boolean","object","array","integer"]}},"required":{"description":"Whether the object holding it requires it.","type":"boolean"},"description":{"type":"string"},"values":{"description":"The only values it takes, when it lists them; a string matching `pattern` or a number in range may be another.","type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"}]}},"pattern":{"type":"string"},"minimum":{"type":"number"},"maximum":{"type":"number"},"min_length":{"type":"number"},"max_length":{"type":"number"},"min_items":{"type":"number"},"max_items":{"type":"number"},"blocks":{"description":"Whether it holds blocks, of the types the body takes.","type":"boolean"}},"required":["path","types","required"]}},"rules":{"description":"What its props must hold together, past each prop's own values.","type":"array","items":{"type":"string"}}},"required":["type","summary","container","props","rules"]}}},"required":["kinds","blocks"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/{kind}/{id}/body":{"get":{"operationId":"readBody","summary":"Reads what the store's home, a page, a product or an entry renders, its body or the default layout without one, and a quiz's or certificate's body; staged reads the unpublished one, and default the default layout even over a body. `getBodySchema` answers the blocks and props each kind of body takes.","tags":["file"],"security":[{"bearer":["file:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"kind","in":"path","required":true,"description":"The target's kind, in the plural.","schema":{"type":"string","minLength":1}},{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"staged","in":"query","description":"Reads the unpublished next body instead of the live one.","schema":{"description":"Reads the unpublished next body instead of the live one.","type":"boolean"}},{"name":"default","in":"query","description":"Answers the default layout the target's page shows without a body (the answer's `default` set), even while it has one, naming that body as `asset`; not with `staged`, and not for a quiz or certificate.","schema":{"description":"Answers the default layout the target's page shows without a body (the answer's `default` set), even while it has one, naming that body as `asset`; not with `staged`, and not for a quiz or certificate.","type":"boolean"}}],"responses":{"200":{"description":"Reads what the store's home, a page, a product or an entry renders, its body or the default layout without one, and a quiz's or certificate's body; staged reads the unpublished one, and default the default layout even over a body. `getBodySchema` answers the blocks and props each kind of body takes.","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"default":{"description":"Set when this is the default layout: the page renders it, having no body of its own, one it can't read or a layout none of whose blocks it shows, or the read asked for it; null for its own body.","anyOf":[{"type":"object","properties":{"template":{"type":"string","x-extensible-enum":["product","blog","podcast","page","portfolio","lesson","article","home","series"]}},"required":["template"]},{"type":"null"}]},"attachment":{"description":"The body's binding, even one its page can't show and shows the default for; null without one.","anyOf":[{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},{"type":"null"}]},"asset":{"description":"The body's file, the `from` a write replacing it names; null without one.","anyOf":[{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},{"type":"null"}]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"content":{"description":"The layout's text, the body's as stored or the default's: a blocks layout's texts in the rich text format.","type":"string","x-rich-text":"body"},"files":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["video","audio","image","pdf","file"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes, null when it has none or is withheld.","anyOf":[{"type":"number"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"description":"Seconds.","anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"url":{"description":"A public file's lasting URL, an image's naming its widths' version as `#v=` once they're made; null for a private one, or one whose bytes haven't landed.","anyOf":[{"type":"string"},{"type":"null"}]},"resized":{"description":"A public image's smaller copies, narrowest first, for a `srcset`; left out until they're made and its width measured, for one kept as uploaded, and for any other file.","type":"array","items":{"type":"object","properties":{"width":{"description":"Its width in pixels, at most the image's own.","type":"integer","minimum":1},"avif":{"description":"A lasting URL to it as AVIF.","type":"string"},"webp":{"description":"A lasting URL to it as WebP.","type":"string"}},"required":["width","avif","webp"]}},"attachment_id":{"description":"The binding a private file opens through; null when the reader can't open it.","anyOf":[{"type":"string"},{"type":"null"}]},"unlocks":{"description":"What unlocks a file its own rules keep from the reader, any one; null for any other file.","anyOf":[{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product_name":{"type":"string"},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]}},"required":["product_id","product_name","tier"]}},{"type":"null"}]},"video":{"description":"A video's subtitles and published AI outputs, where its read lists any and the reader may play it.","type":"object","properties":{"attachment_id":{"type":"string"},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["attachment_id","tracks","outputs"]},"audio":{"description":"An audio file's waveform, subtitles and published AI outputs, where the reader may play it.","type":"object","properties":{"waveform":{"description":"256 levels from 0 to 255, base64, from the file's start to its end; null until drawn, or when it can't be.","anyOf":[{"type":"string"},{"type":"null"}]},"attachment_id":{"description":"The binding its tracks and outputs open through, which a public file carries here alone; null with none.","anyOf":[{"type":"string"},{"type":"null"}]},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["waveform","attachment_id","tracks","outputs"]}},"required":["id","kind","mime","name","bytes","width","height","duration","pages","status","url","attachment_id","unlocks"]}},"maps":{"description":"The maps its map blocks show, one per point drawn so far, matched to a block by `latitude` and `longitude`; none for a default.","type":"array","items":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"},"light":{"description":"For a light page.","type":"object","properties":{"url":{"description":"A lasting URL to the image.","type":"string"},"width":{"description":"Its size in pixels.","type":"number"},"height":{"type":"number"},"resized":{"description":"Its smaller copies, narrowest first; null until made.","anyOf":[{"type":"array","items":{"type":"object","properties":{"width":{"description":"Its width in pixels, at most the image's own.","type":"integer","minimum":1},"avif":{"description":"A lasting URL to it as AVIF.","type":"string"},"webp":{"description":"A lasting URL to it as WebP.","type":"string"}},"required":["width","avif","webp"]}},{"type":"null"}]}},"required":["url","width","height"]},"dark":{"description":"For a dark page.","type":"object","properties":{"url":{"description":"A lasting URL to the image.","type":"string"},"width":{"description":"Its size in pixels.","type":"number"},"height":{"type":"number"},"resized":{"description":"Its smaller copies, narrowest first; null until made.","anyOf":[{"type":"array","items":{"type":"object","properties":{"width":{"description":"Its width in pixels, at most the image's own.","type":"integer","minimum":1},"avif":{"description":"A lasting URL to it as AVIF.","type":"string"},"webp":{"description":"A lasting URL to it as WebP.","type":"string"}},"required":["width","avif","webp"]}},{"type":"null"}]}},"required":["url","width","height"]},"attribution":{"description":"The credit shown over the map, linking `attribution_url`.","type":"string"},"attribution_url":{"type":"string"}},"required":["latitude","longitude","light","dark","attribution","attribution_url"]}},"product_fields":{"description":"On a product, whether its page shows the product's `description` and `what_you_get`, each only where the layout places its block; null on any other target, or for a body that isn't a layout it reads.","anyOf":[{"type":"object","properties":{"description":{"type":"boolean"},"what_you_get":{"type":"boolean"}},"required":["description","what_you_get"]},{"type":"null"}]},"preview":{"description":"The body's page on the store with a token opening it, for an hour; null where none is answered.","anyOf":[{"type":"object","properties":{"url":{"description":"The page, opening its staged body (else its live one) and an unpublished target, while the token lives.","type":"string"},"expires_at":{"description":"When the token stops opening the page, which then shows as a visitor sees it.","type":"string"}},"required":["url","expires_at"]},{"type":"null"}]}},"required":["default","attachment","asset","mime","content","files","maps","product_fields","preview"]},{"type":"null"}]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"put":{"operationId":"setBody","summary":"Writes the live body of the store's home, a page, a product or an entry, or with `staged: true` its unpublished next body, which `publishBody` publishes; `from` names the body read, so a write over one changed since is refused. Ask `getBodySchema` for the blocks, props and values its kind takes before writing: anything else is refused, naming the block, the prop and what it takes.","tags":["file"],"security":[{"bearer":["file:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"kind","in":"path","required":true,"description":"The target's kind, in the plural.","schema":{"type":"string","minLength":1}},{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Writes the live body of the store's home, a page, a product or an entry, or with `staged: true` its unpublished next body, which `publishBody` publishes; `from` names the body read, so a write over one changed since is refused. Ask `getBodySchema` for the blocks, props and values its kind takes before writing: anything else is refused, naming the block, the prop and what it takes.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"attachment":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"asset":{"description":"The asset the body holds now: the next write's `from` (or a staged write's `live`).","type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"created":{"description":"The attachments the write bound: the embeds a live write or a publish derived.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string","x-extensible-enum":["prose","teaser","embed"]},"asset":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["id","role","asset"]}},"attachments":{"description":"Every attachment on the target with its asset whole; answered only with `full`.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"target":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"}},"required":["kind","id"]},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"from_body":{"type":"boolean"},"release_file":{"description":"A file a software release ships, which its release edits and the product's own list leaves out.","type":"boolean"},"position":{"type":"number"},"asset":{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}},"required":["id","target","role","delivery","preview_only","from_body","release_file","position","asset"]}},"preview":{"description":"The body's page on the store with a token opening it, for an hour; null where none is answered.","anyOf":[{"type":"object","properties":{"url":{"description":"The page, opening its staged body (else its live one) and an unpublished target, while the token lives.","type":"string"},"expires_at":{"description":"When the token stops opening the page, which then shows as a visitor sees it.","type":"string"}},"required":["url","expires_at"]},{"type":"null"}]}},"required":["attachment","asset","created","preview"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text_format":{"type":"string","enum":["html","markdown"],"default":"html","description":"The format the rich text fields are written in: the rich text format’s HTML, or Markdown converted into it before it is validated. A text already stored in the format (starting with `<rich-text`) is kept as it is either way."},"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true},"content":{"description":"The body's text, a blocks layout whose texts (a markdown block's `content`, and those its blocks nest) are rich texts, stored in its canonical form in 1 MiB of UTF-8; an image it starts showing is at most 15 MB.","type":"string","x-rich-text":"body","minLength":1,"maxLength":262144},"from":{"description":"The `asset.id` the body (or the staged body) held when the caller read it, never its `attachment.id`; null when it had none.","anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"null"}]},"staged":{"description":"Writes the unpublished next body instead of the live one.","type":"boolean"},"live":{"description":"On a staged write, the live body's `asset.id` the caller started from, never its `attachment.id`; null when there was none.","anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"null"}]},"unpublished":{"description":"On a live write, the caller saved it believing its page or product isn't live.","type":"boolean","const":true}},"required":["content","from"],"additionalProperties":false}}}}}},"/v1/stores/{store}/{kind}/{id}/body/edit":{"post":{"operationId":"editBody","summary":"Updates, inserts, moves or deletes blocks of a body by id, without sending it whole. `getBodySchema` answers the props each block takes.","tags":["file"],"security":[{"bearer":["file:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"kind","in":"path","required":true,"description":"The target's kind, in the plural.","schema":{"type":"string","minLength":1}},{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Updates, inserts, moves or deletes blocks of a body by id, without sending it whole. `getBodySchema` answers the props each block takes.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"blocks":{"type":"array","items":{"type":"string"}},"attachment":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"asset":{"description":"The asset the body holds now: the next write's `from` (or a staged write's `live`).","type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"created":{"description":"The attachments the write bound: the embeds a live write or a publish derived.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string","x-extensible-enum":["prose","teaser","embed"]},"asset":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["id","role","asset"]}},"attachments":{"description":"Every attachment on the target with its asset whole; answered only with `full`.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"target":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"}},"required":["kind","id"]},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"from_body":{"type":"boolean"},"release_file":{"description":"A file a software release ships, which its release edits and the product's own list leaves out.","type":"boolean"},"position":{"type":"number"},"asset":{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}},"required":["id","target","role","delivery","preview_only","from_body","release_file","position","asset"]}},"preview":{"description":"The body's page on the store with a token opening it, for an hour; null where none is answered.","anyOf":[{"type":"object","properties":{"url":{"description":"The page, opening its staged body (else its live one) and an unpublished target, while the token lives.","type":"string"},"expires_at":{"description":"When the token stops opening the page, which then shows as a visitor sees it.","type":"string"}},"required":["url","expires_at"]},{"type":"null"}]}},"required":["blocks","attachment","asset","created","preview"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text_format":{"type":"string","enum":["html","markdown"],"default":"html","description":"The format the rich text fields are written in: the rich text format’s HTML, or Markdown converted into it before it is validated. A text already stored in the format (starting with `<rich-text`) is kept as it is either way."},"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true},"from":{"description":"The `asset.id` the body (or the staged body) held when the caller read it, never its `attachment.id`; null for a first staged body, which the edits start from the live one.","anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"null"}]},"staged":{"description":"Edits the unpublished next body instead of the live one.","type":"boolean"},"live":{"description":"On a first staged edit, the live body's `asset.id` the edits start from, never its `attachment.id`.","anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"null"}]},"unpublished":{"description":"On a live edit, the caller made it believing its page or product isn't live.","type":"boolean","const":true},"edits":{"description":"The edits, applied in order, landing together or not at all.","type":"array","items":{"anyOf":[{"type":"object","properties":{"kind":{"description":"Sets the block's props, or replaces the block with `replace`; its id stays.","type":"string","const":"update"},"id":{"description":"The block's id, as `readBody`'s content holds it.","type":"string","minLength":1,"maxLength":512},"block":{"description":"The props to set as a JSON object with the block's `type`, a `null` one removed; with `replace`, the whole block, of any type. A block it holds with no `id` takes a new one. Its texts are rich texts; an image it starts showing is at most 15 MB.","type":"string","x-rich-text":"body","minLength":2,"maxLength":262144},"replace":{"description":"Replaces the whole block instead of setting the props given.","type":"boolean","const":true}},"required":["kind","id","block"],"additionalProperties":false},{"type":"object","properties":{"kind":{"description":"Adds a block.","type":"string","const":"insert"},"block":{"description":"The block as a JSON object; one with no `id` takes a new one, which the write answers, as does each block it holds with none. Its texts are rich texts; an image it starts showing is at most 15 MB.","type":"string","x-rich-text":"body","minLength":2,"maxLength":262144},"after":{"description":"The block it goes after, in the list that holds that block.","type":"string","minLength":1,"maxLength":512},"at":{"description":"The start or end of the body's top-level blocks, when it names no block to follow; on a product page, a block that is no column starts after its columns.","type":"string","enum":["start","end"]}},"required":["kind","block"],"additionalProperties":false},{"type":"object","properties":{"kind":{"description":"Moves a block, with what it holds.","type":"string","const":"move"},"id":{"description":"The block's id, as `readBody`'s content holds it.","type":"string","minLength":1,"maxLength":512},"after":{"description":"The block it goes after, in the list that holds that block.","type":"string","minLength":1,"maxLength":512},"at":{"description":"The start or end of the body's top-level blocks, when it names no block to follow; on a product page, a block that is no column starts after its columns.","type":"string","enum":["start","end"]}},"required":["kind","id"],"additionalProperties":false},{"type":"object","properties":{"kind":{"description":"Removes a block, with what it holds.","type":"string","const":"delete"},"id":{"description":"The block's id, as `readBody`'s content holds it.","type":"string","minLength":1,"maxLength":512}},"required":["kind","id"],"additionalProperties":false}]},"minItems":1,"maxItems":100}},"required":["from","edits"],"additionalProperties":false}}}}}},"/v1/stores/{store}/{kind}/{id}/body/publish":{"post":{"operationId":"publishBody","summary":"Publishes the staged body.","tags":["file"],"security":[{"bearer":["file:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"kind","in":"path","required":true,"description":"The target's kind, in the plural.","schema":{"type":"string","minLength":1}},{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Publishes the staged body.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"attachment":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"asset":{"description":"The asset the body holds now: the next write's `from` (or a staged write's `live`).","type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"created":{"description":"The attachments the write bound: the embeds a live write or a publish derived.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string","x-extensible-enum":["prose","teaser","embed"]},"asset":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["id","role","asset"]}},"attachments":{"description":"Every attachment on the target with its asset whole; answered only with `full`.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"target":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"}},"required":["kind","id"]},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"from_body":{"type":"boolean"},"release_file":{"description":"A file a software release ships, which its release edits and the product's own list leaves out.","type":"boolean"},"position":{"type":"number"},"asset":{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}},"required":["id","target","role","delivery","preview_only","from_body","release_file","position","asset"]}}},"required":["attachment","asset","created"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"from":{"description":"The staged body's `asset.id` the caller saw, never its `attachment.id`.","type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true},"live":{"description":"The live body's `asset.id` the caller loaded, never its `attachment.id`; null when there was none. A publish over one replaced since is refused.","anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"null"}]}},"required":["from"],"additionalProperties":false}}}}}},"/v1/stores/{store}/{kind}/{id}/body/discard":{"post":{"operationId":"discardStaged","summary":"Discards the staged body, keeping the published one.","tags":["file"],"security":[{"bearer":["file:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"kind","in":"path","required":true,"description":"The target's kind, in the plural.","schema":{"type":"string","minLength":1}},{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Discards the staged body, keeping the published one.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean","const":true}},"required":["id","deleted"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"from":{"description":"The staged body's `asset.id` the caller saw, never its `attachment.id`.","type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"required":["from"],"additionalProperties":false}}}}}},"/v1/stores/{store}/attachments/{attachment}":{"patch":{"operationId":"updateAttachment","summary":"Updates an attachment's role, delivery or preview flag.","tags":["file"],"security":[{"bearer":["file:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"attachment","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Updates an attachment's role, delivery or preview flag.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"target":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"}},"required":["kind","id"]},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"from_body":{"type":"boolean"},"release_file":{"description":"A file a software release ships, which its release edits and the product's own list leaves out.","type":"boolean"},"position":{"type":"number"},"asset":{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}},"required":["id","target","role","delivery","preview_only","from_body","release_file","position","asset"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"asset":{"description":"Swapped in place; on the store's home only its body or stylesheet takes another file. A poster, and an image a product binds as `embed`, takes one of at most 15 MB.","type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"from":{"description":"The asset the caller saw bound; any other refuses.","type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"from_role":{"description":"The role the caller saw it hold; another refuses.","type":"string","enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"from_delivery":{"description":"The delivery the caller saw it served by; another refuses.","type":"string","enum":["inline","download","stream"]},"body":{"description":"The body the caller saw on the target, null for none; another refuses.","anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"null"}]},"kind":{"description":"The file it holds after the write must be of this kind, as a lesson's video swapped, or it refuses `conflict` on `mime` with the reason.","type":"string","enum":["video","audio","pdf"]},"role":{"description":"A move on the store's home lands only in `body` or `stylesheet`; a poster, or an image moved into a product's `embed`, is at most 15 MB.","type":"string","enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"description":"The seller's pick, which a save of the text no longer flips with its use.","type":"string","enum":["inline","download","stream"]},"preview_only":{"description":"True drops every gate row of the attachment's own, which takes the gate's scopes.","type":"boolean"},"position":{"type":"integer","minimum":0,"maximum":1000000},"download_tier":{"description":"Who may download a lesson's slides bound as a download: a tier and above, or null for whoever opens them; takes the gate's scopes.","anyOf":[{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"additionalProperties":false},{"type":"null"}]}},"additionalProperties":false}}}}}},"/v1/stores/{store}/{kind}/{id}/attachments/reorder":{"post":{"operationId":"reorderAttachments","summary":"Sets the order of a resource's attachments.","tags":["file"],"security":[{"bearer":["file:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"kind","in":"path","required":true,"description":"The target's kind, in the plural.","schema":{"type":"string","minLength":1}},{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Sets the order of a resource's attachments.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"target":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"}},"required":["kind","id"]},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"from_body":{"type":"boolean"},"release_file":{"description":"A file a software release ships, which its release edits and the product's own list leaves out.","type":"boolean"},"position":{"type":"number"},"asset":{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}},"required":["id","target","role","delivery","preview_only","from_body","release_file","position","asset"]}}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"string","enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"expect":{"description":"The group's order as the caller read it; another order now refuses.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}}},"required":["role","attachments"],"additionalProperties":false}}}}}},"/v1/stores/{store}/attachments/{attachment}/detach":{"post":{"operationId":"detachAttachment","summary":"Detaches a file from a resource, keeping the file.","tags":["file"],"security":[{"bearer":["file:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"attachment","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Detaches a file from a resource, keeping the file.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean","const":true}},"required":["id","deleted"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"from":{"description":"The asset the caller saw bound; any other refuses.","type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"from_role":{"description":"The role the caller saw it hold; another refuses.","type":"string","enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"body":{"description":"The body the caller saw on the target, null for none; another refuses.","anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"null"}]}},"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/prompts":{"get":{"operationId":"listPrompts","summary":"Pages a product's MCP prompts with their text.","tags":["file"],"security":[{"bearer":["file:read","product:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["position"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Pages a product's MCP prompts with their text.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"body":{"type":"string"},"arguments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}},"access":{"anyOf":[{"type":"object","properties":{"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["tier_id"]},{"type":"null"}]},"position":{"type":"number"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","product_id","name","title","description","body","arguments","access","position","created_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"post":{"operationId":"createPrompt","summary":"Adds an MCP prompt to a product.","tags":["file"],"security":[{"bearer":["file:write","product:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"201":{"description":"Adds an MCP prompt to a product.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"body":{"type":"string"},"arguments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}},"access":{"anyOf":[{"type":"object","properties":{"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["tier_id"]},{"type":"null"}]},"position":{"type":"number"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","product_id","name","title","description","body","arguments","access","position","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"A slash command, unique among the store's prompts.","type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z0-9][a-z0-9-]*$"},"title":{"type":"string","minLength":1,"maxLength":200},"description":{"anyOf":[{"type":"string","minLength":1,"maxLength":500},{"type":"null"}]},"body":{"description":"The prompt's markdown: 100000 bytes of UTF-8, so a quarter as many characters always fit.","type":"string","minLength":1,"maxLength":25000},"arguments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z_][A-Za-z0-9_-]*$"},"description":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"required":{"description":"A required argument takes no default.","type":"boolean"},"default":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u`, each once, the pattern runs with; null for `i` alone.","anyOf":[{"type":"string","maxLength":3,"pattern":"^[isu]*$"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"lenient":{"description":"Whether a value `match` refuses falls back to the default; only an argument with one.","type":"boolean"}},"required":["name"],"additionalProperties":false},"maxItems":20},"access":{"anyOf":[{"type":"object","properties":{"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"null"}]}},"required":["tier"],"additionalProperties":false},{"type":"null"}]}},"required":["name","title","body"],"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/prompts/{prompt}":{"get":{"operationId":"getPrompt","summary":"Reads one of a product's MCP prompts.","tags":["file"],"security":[{"bearer":["file:read","product:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"prompt","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Reads one of a product's MCP prompts.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"body":{"type":"string"},"arguments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}},"access":{"anyOf":[{"type":"object","properties":{"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["tier_id"]},{"type":"null"}]},"position":{"type":"number"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","product_id","name","title","description","body","arguments","access","position","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"patch":{"operationId":"updatePrompt","summary":"Updates an MCP prompt's fields, text or access.","tags":["file"],"security":[{"bearer":["file:write","product:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"prompt","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Updates an MCP prompt's fields, text or access.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"body":{"type":"string"},"arguments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}},"access":{"anyOf":[{"type":"object","properties":{"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["tier_id"]},{"type":"null"}]},"position":{"type":"number"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","product_id","name","title","description","body","arguments","access","position","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"A slash command, unique among the store's prompts.","type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z0-9][a-z0-9-]*$"},"title":{"type":"string","minLength":1,"maxLength":200},"description":{"anyOf":[{"type":"string","minLength":1,"maxLength":500},{"type":"null"}]},"body":{"description":"The prompt's markdown: 100000 bytes of UTF-8, so a quarter as many characters always fit.","type":"string","minLength":1,"maxLength":25000},"access":{"anyOf":[{"type":"object","properties":{"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"null"}]}},"required":["tier"],"additionalProperties":false},{"type":"null"}]},"arguments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z_][A-Za-z0-9_-]*$"},"description":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"required":{"description":"A required argument takes no default.","type":"boolean"},"default":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u`, each once, the pattern runs with; null for `i` alone.","anyOf":[{"type":"string","maxLength":3,"pattern":"^[isu]*$"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"lenient":{"description":"Whether a value `match` refuses falls back to the default; only an argument with one.","type":"boolean"}},"required":["name"],"additionalProperties":false},"maxItems":20}},"additionalProperties":false}}}}},"delete":{"operationId":"deletePrompt","summary":"Deletes an MCP prompt.","tags":["file"],"security":[{"bearer":["file:delete","product:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"prompt","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Deletes an MCP prompt.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean","const":true}},"required":["id","deleted"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/poster":{"put":{"operationId":"setProductPoster","summary":"Sets, swaps or clears a product's thumbnail, its first poster, if it is still the one the caller saw.","tags":["file"],"security":[{"bearer":["file:write","product:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Sets, swaps or clears a product's thumbnail, its first poster, if it is still the one the caller saw.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"product":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"poster":{"type":"null"}},"required":["product","poster"]},{"type":"object","properties":{"product":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"poster":{"type":"object","properties":{"id":{"type":"string"},"target":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"}},"required":["kind","id"]},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"preview_only":{"type":"boolean"},"from_body":{"type":"boolean"},"release_file":{"description":"A file a software release ships, which its release edits and the product's own list leaves out.","type":"boolean"},"position":{"type":"number"},"asset":{"type":"object","properties":{"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}},"required":["id","target","role","delivery","preview_only","from_body","release_file","position","asset"]}},"required":["product","poster"]}]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"asset":{"description":"The file to show, or null to show none.","anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"null"}]},"from":{"description":"The first poster the caller saw, or null for none; a product showing another refuses.","anyOf":[{"type":"object","properties":{"attachment":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"asset":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"required":["attachment","asset"],"additionalProperties":false},{"type":"null"}]}},"required":["asset","from"],"additionalProperties":false}}}}}},"/v1/stores/{store}/{kind}/{id}/access_requirements":{"get":{"operationId":"listAccessRequirements","summary":"Lists the tiers that unlock a product, entry, page or file.","tags":["product"],"security":[{"bearer":["product:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"kind","in":"path","required":true,"description":"The target's kind, in the plural.","schema":{"type":"string","minLength":1}},{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Lists the tiers that unlock a product, entry, page or file.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"resource":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry","download","quiz","attachment","page"]},"id":{"type":"string"}},"required":["kind","id"]},"channel":{"type":"string","x-extensible-enum":["api","web","mcp","feed","any"]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"closed":{"type":"boolean"}},"required":["resource","channel","tier_id","closed"]}}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"put":{"operationId":"setAccessRequirement","summary":"Requires a tier to unlock a resource.","tags":["product"],"security":[{"bearer":["product:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"kind","in":"path","required":true,"description":"The target's kind, in the plural.","schema":{"type":"string","minLength":1}},{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Requires a tier to unlock a resource.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"resource":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry","download","quiz","attachment","page"]},"id":{"type":"string"}},"required":["kind","id"]},"channel":{"type":"string","x-extensible-enum":["api","web","mcp","feed","any"]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"closed":{"type":"boolean"}},"required":["resource","channel","tier_id","closed"]}}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"channel":{"type":"string","enum":["api","web","mcp","feed","any"]},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"null"}]},"closed":{"description":"Shuts a product to everyone over MCP, all it heads included; it takes no tier.","type":"boolean"},"from":{"type":"object","properties":{"preview_only":{"type":"boolean"},"asset":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"additionalProperties":false},"if_none":{"description":"Refused when the resource already has a row on the channel, as a rule put back over one set since.","type":"boolean"}},"required":["channel","tier"],"additionalProperties":false}}}}},"delete":{"operationId":"clearAccessRequirement","summary":"Removes a tier requirement from a resource.","tags":["product"],"security":[{"bearer":["product:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"kind","in":"path","required":true,"description":"The target's kind, in the plural.","schema":{"type":"string","minLength":1}},{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"channel","in":"query","required":true,"schema":{"type":"string","enum":["api","web","mcp","feed","any"]}},{"name":"from","in":"query","style":"deepObject","explode":true,"schema":{"type":"object","properties":{"preview_only":{"type":"boolean"},"asset":{"type":"string","minLength":1,"description":"An id."}},"additionalProperties":false}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Removes a tier requirement from a resource.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"resource":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry","download","quiz","attachment","page"]},"id":{"type":"string"}},"required":["kind","id"]},"channel":{"type":"string","x-extensible-enum":["api","web","mcp","feed","any"]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"closed":{"type":"boolean"}},"required":["resource","channel","tier_id","closed"]}}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/access_requirements/query":{"post":{"operationId":"listResourceAccess","summary":"Reads the access requirements of many resources at once.","tags":["product"],"security":[{"bearer":["product:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Reads the access requirements of many resources at once.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"resource":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry","download","quiz","attachment","page"]},"id":{"type":"string","minLength":1,"maxLength":512}},"required":["kind","id"]},"requirements":{"type":"array","items":{"type":"object","properties":{"resource":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry","download","quiz","attachment","page"]},"id":{"type":"string"}},"required":["kind","id"]},"channel":{"type":"string","x-extensible-enum":["api","web","mcp","feed","any"]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"closed":{"type":"boolean"}},"required":["resource","channel","tier_id","closed"]}}},"required":["resource","requirements"]}}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"resources":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["product","entry","download","quiz","attachment","page"]},"id":{"type":"string","minLength":1,"maxLength":512}},"required":["kind","id"],"additionalProperties":false},"minItems":1,"maxItems":500}},"required":["resources"],"additionalProperties":false}}}},"x-read-only":true}},"/v1/stores/{store}/assets":{"get":{"operationId":"listAssets","summary":"Pages the store's files.","tags":["file"],"security":[{"bearer":["file:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["created","name","size"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"search","in":"query","schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"facets","in":"query","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["status","origin"]}}}],"responses":{"200":{"description":"Pages the store's files.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"uses":{"type":"object","properties":{"total":{"type":"number"},"first":{"anyOf":[{"type":"object","properties":{"attachment_id":{"type":"string"},"asset_id":{"type":"string"},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"target":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry","store","quiz","certificate","holding","page"]},"id":{"type":"string"}},"required":["kind","id"]},"from_body":{"type":"boolean"},"detachable":{"type":"boolean"},"release":{"description":"The software release shipping it, whether it is the current download, and the release holders download once it goes; null for a file no release ships.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"},"current":{"type":"boolean"},"after":{"description":"The release whose files holders download once this file is gone; null when none would ship any.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"}},"required":["id","version"]},{"type":"null"}]}},"required":["id","version","current","after"]},{"type":"null"}]}},"required":["attachment_id","asset_id","role","delivery","target","from_body","detachable","release"]},{"type":"null"}]}},"required":["total","first"]},"replace_failed":{"type":"boolean"},"movable":{"type":"boolean"},"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["uses","replace_failed","movable","id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"post":{"operationId":"createAsset","summary":"Creates a link file, such as an external video.","tags":["file"],"security":[{"bearer":["file:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"201":{"description":"Creates a link file, such as an external video.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"transforms":{"type":"array","items":{"type":"object","properties":{"stage":{"type":"string","x-extensible-enum":["ingest","derive","deliver"]},"params":{"type":"object","properties":{"level":{"type":"string","x-extensible-enum":["basic","full"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"position":{"type":"number"}},"required":["stage","params","position"]}},"deliveries":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"asset_id":{"type":"string"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"member_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"intent":{"type":"string","x-extensible-enum":["preview","download","stream"]},"channel":{"type":"string","x-extensible-enum":["api","web","mcp","feed","staff"]},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"expires_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revoked_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"max_uses":{"anyOf":[{"type":"number"},{"type":"null"}]},"used_count":{"type":"number"},"used_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"type":"string","x-extensible-enum":["expired","revoked","used","unused"]}},"required":["id","asset_id","customer_id","member_id","intent","channel","issued_at","expires_at","revoked_at","max_uses","used_count","used_at","state"]}},"total":{"type":"number"}},"required":["items","total"]},"uses":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"attachment_id":{"type":"string"},"asset_id":{"type":"string"},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"target":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry","store","quiz","certificate","holding","page"]},"id":{"type":"string"}},"required":["kind","id"]},"from_body":{"type":"boolean"},"detachable":{"type":"boolean"},"release":{"description":"The software release shipping it, whether it is the current download, and the release holders download once it goes; null for a file no release ships.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"},"current":{"type":"boolean"},"after":{"description":"The release whose files holders download once this file is gone; null when none would ship any.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"}},"required":["id","version"]},{"type":"null"}]}},"required":["id","version","current","after"]},{"type":"null"}]}},"required":["attachment_id","asset_id","role","delivery","target","from_body","detachable","release"]}},"total":{"type":"number"},"detachable":{"type":"number"}},"required":["items","total","detachable"]},"children":{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"}},"total":{"type":"number"}},"required":["items","total"]},"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["transforms","deliveries","uses","children","id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"storage":{"description":"Deprecated: send `enforcement` instead.","type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false,"deprecated":true},"locator":{"type":"string","minLength":1,"maxLength":100000},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^[a-z0-9][a-z0-9-]*$"},"title":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"ext":{"anyOf":[{"type":"string","minLength":1,"maxLength":16},{"type":"null"}]},"mime":{"description":"A link's type; a stored file's is the one it was stored with.","anyOf":[{"type":"string","maxLength":128,"pattern":"^\\s*(?:[a-zA-Z0-9][a-zA-Z0-9!#$&^_.+-]*\\/[a-zA-Z0-9][a-zA-Z0-9!#$&^_.+-]*(?:([\\t ]*;)(?:([\\t ]*)([!#$%&'*+.^_`|~0-9A-Za-z-]+)(=(?:[!#$%&'*+.^_`|~0-9A-Za-z-]+|\"(?:[\\t \\x21\\x23-\\x5b\\x5d-\\x7e]|\\\\[\\t\\x20-\\x7e])*\")))?)*)?\\s*$"},{"type":"null"}]},"custodian":{"type":"string","enum":["platform","seller","external"]},"enforcement":{"description":"How the file is served: `public` to anyone with its link, `signed` (a stored file's default) only through links that expire, `external` for a link held elsewhere (a link's default).","type":"string","enum":["public","external","signed"]},"redacted":{"type":"boolean"},"description":{"anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]},"metadata":{"type":"object","properties":{"transcript":{"type":"object","properties":{"language":{"type":"string","minLength":1,"maxLength":35}},"additionalProperties":false}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["locator","name"],"additionalProperties":false}}}}}},"/v1/stores/{store}/assets/{asset}":{"get":{"operationId":"getAsset","summary":"Reads one file.","tags":["file"],"security":[{"bearer":["file:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"asset","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Reads one file.","content":{"application/json":{"schema":{"type":"object","properties":{"kept_kind":{"description":"The kind a replace or a type change must keep: `pdf` for a lesson's slides, `video` for its video, `audio` for a podcast episode's audio; null when none holds one.","anyOf":[{"type":"string","x-extensible-enum":["video","audio","pdf"]},{"type":"null"}]},"lineage":{"type":"object","properties":{"assets":{"type":"number"},"uses":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"attachment_id":{"type":"string"},"asset_id":{"type":"string"},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"target":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry","store","quiz","certificate","holding","page"]},"id":{"type":"string"}},"required":["kind","id"]},"from_body":{"type":"boolean"},"detachable":{"type":"boolean"},"release":{"description":"The software release shipping it, whether it is the current download, and the release holders download once it goes; null for a file no release ships.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"},"current":{"type":"boolean"},"after":{"description":"The release whose files holders download once this file is gone; null when none would ship any.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"}},"required":["id","version"]},{"type":"null"}]}},"required":["id","version","current","after"]},{"type":"null"}]}},"required":["attachment_id","asset_id","role","delivery","target","from_body","detachable","release"]}},"total":{"type":"number"},"detachable":{"type":"number"}},"required":["items","total","detachable"]},"deliveries":{"type":"object","properties":{"total":{"type":"number"}},"required":["total"]},"quota_bytes":{"description":"The files' size in bytes, as they count against the store's storage.","type":"number"}},"required":["assets","uses","deliveries","quota_bytes"]},"bindings":{"type":"string"},"transforms":{"type":"array","items":{"type":"object","properties":{"stage":{"type":"string","x-extensible-enum":["ingest","derive","deliver"]},"params":{"type":"object","properties":{"level":{"type":"string","x-extensible-enum":["basic","full"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"position":{"type":"number"}},"required":["stage","params","position"]}},"deliveries":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"asset_id":{"type":"string"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"member_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"intent":{"type":"string","x-extensible-enum":["preview","download","stream"]},"channel":{"type":"string","x-extensible-enum":["api","web","mcp","feed","staff"]},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"expires_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revoked_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"max_uses":{"anyOf":[{"type":"number"},{"type":"null"}]},"used_count":{"type":"number"},"used_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"type":"string","x-extensible-enum":["expired","revoked","used","unused"]}},"required":["id","asset_id","customer_id","member_id","intent","channel","issued_at","expires_at","revoked_at","max_uses","used_count","used_at","state"]}},"total":{"type":"number"}},"required":["items","total"]},"uses":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"attachment_id":{"type":"string"},"asset_id":{"type":"string"},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"target":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry","store","quiz","certificate","holding","page"]},"id":{"type":"string"}},"required":["kind","id"]},"from_body":{"type":"boolean"},"detachable":{"type":"boolean"},"release":{"description":"The software release shipping it, whether it is the current download, and the release holders download once it goes; null for a file no release ships.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"},"current":{"type":"boolean"},"after":{"description":"The release whose files holders download once this file is gone; null when none would ship any.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"}},"required":["id","version"]},{"type":"null"}]}},"required":["id","version","current","after"]},{"type":"null"}]}},"required":["attachment_id","asset_id","role","delivery","target","from_body","detachable","release"]}},"total":{"type":"number"},"detachable":{"type":"number"}},"required":["items","total","detachable"]},"children":{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"}},"total":{"type":"number"}},"required":["items","total"]},"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["kept_kind","lineage","bindings","transforms","deliveries","uses","children","id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"patch":{"operationId":"updateAsset","summary":"Updates a file's name, title, description and security level.","tags":["file"],"security":[{"bearer":["file:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"asset","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Updates a file's name, title, description and security level.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"transforms":{"type":"array","items":{"type":"object","properties":{"stage":{"type":"string","x-extensible-enum":["ingest","derive","deliver"]},"params":{"type":"object","properties":{"level":{"type":"string","x-extensible-enum":["basic","full"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"position":{"type":"number"}},"required":["stage","params","position"]}},"deliveries":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"asset_id":{"type":"string"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"member_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"intent":{"type":"string","x-extensible-enum":["preview","download","stream"]},"channel":{"type":"string","x-extensible-enum":["api","web","mcp","feed","staff"]},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"expires_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revoked_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"max_uses":{"anyOf":[{"type":"number"},{"type":"null"}]},"used_count":{"type":"number"},"used_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"type":"string","x-extensible-enum":["expired","revoked","used","unused"]}},"required":["id","asset_id","customer_id","member_id","intent","channel","issued_at","expires_at","revoked_at","max_uses","used_count","used_at","state"]}},"total":{"type":"number"}},"required":["items","total"]},"uses":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"attachment_id":{"type":"string"},"asset_id":{"type":"string"},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"target":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry","store","quiz","certificate","holding","page"]},"id":{"type":"string"}},"required":["kind","id"]},"from_body":{"type":"boolean"},"detachable":{"type":"boolean"},"release":{"description":"The software release shipping it, whether it is the current download, and the release holders download once it goes; null for a file no release ships.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"},"current":{"type":"boolean"},"after":{"description":"The release whose files holders download once this file is gone; null when none would ship any.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"}},"required":["id","version"]},{"type":"null"}]}},"required":["id","version","current","after"]},{"type":"null"}]}},"required":["attachment_id","asset_id","role","delivery","target","from_body","detachable","release"]}},"total":{"type":"number"},"detachable":{"type":"number"}},"required":["items","total","detachable"]},"children":{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"}},"total":{"type":"number"}},"required":["items","total"]},"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["transforms","deliveries","uses","children","id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"attachment":{"description":"The binding the caller saw holding the file; one holding another refuses.","type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"locator":{"description":"A link's URL; only a link held elsewhere takes one.","type":"string","minLength":1,"maxLength":100000},"security":{"description":"The protection a stored PDF or spreadsheet is delivered with, refused for one no mark can be written into; null takes it off.","anyOf":[{"type":"string","enum":["basic","full"]},{"type":"null"}]},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^[a-z0-9][a-z0-9-]*$"},"title":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"description":{"anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]},"metadata":{"type":"object","properties":{"transcript":{"type":"object","properties":{"language":{"type":"string","minLength":1,"maxLength":35}},"additionalProperties":false}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"enforcement":{"description":"How the file is served: `public` to anyone with its link, `signed` (a stored file's default) only through links that expire, `external` for a link held elsewhere (a link's default).","type":"string","enum":["public","external","signed"]},"mime":{"description":"A link's type; a stored file's is the one it was stored with.","anyOf":[{"type":"string","maxLength":128,"pattern":"^\\s*(?:[a-zA-Z0-9][a-zA-Z0-9!#$&^_.+-]*\\/[a-zA-Z0-9][a-zA-Z0-9!#$&^_.+-]*(?:([\\t ]*;)(?:([\\t ]*)([!#$%&'*+.^_`|~0-9A-Za-z-]+)(=(?:[!#$%&'*+.^_`|~0-9A-Za-z-]+|\"(?:[\\t \\x21\\x23-\\x5b\\x5d-\\x7e]|\\\\[\\t\\x20-\\x7e])*\")))?)*)?\\s*$"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string","minLength":1,"maxLength":16},{"type":"null"}]},"redacted":{"type":"boolean"}},"additionalProperties":false}}}}},"delete":{"operationId":"deleteAsset","summary":"Deletes a file nothing uses.","tags":["file"],"security":[{"bearer":["file:delete"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"asset","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"detach","in":"query","schema":{"type":"boolean"}},{"name":"bindings","in":"query","description":"The digest `getAsset` answers.","schema":{"description":"The digest `getAsset` answers.","type":"string","minLength":64,"maxLength":64,"pattern":"^[0-9a-f]{64}$"}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Deletes a file nothing uses.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean","const":true}},"required":["id","deleted"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/quota":{"get":{"operationId":"getQuota","summary":"Reads the store's storage use against its plan's allowance, and the time zone its files' deliveries are dated in.","tags":["file"],"security":[{"bearer":["file:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Reads the store's storage use against its plan's allowance, and the time zone its files' deliveries are dated in.","content":{"application/json":{"schema":{"type":"object","properties":{"used_bytes":{"description":"The files' size in bytes, as they count against the store's storage.","type":"number"},"assets":{"type":"number"},"allowance_bytes":{"type":"number"},"available_bytes":{"type":"number"},"by_type":{"type":"object","properties":{"video":{"type":"object","properties":{"bytes":{"description":"The files' size in bytes, as they count against the store's storage.","type":"number"},"assets":{"type":"number"}},"required":["bytes","assets"]},"audio":{"type":"object","properties":{"bytes":{"description":"The files' size in bytes, as they count against the store's storage.","type":"number"},"assets":{"type":"number"}},"required":["bytes","assets"]},"image":{"type":"object","properties":{"bytes":{"description":"The files' size in bytes, as they count against the store's storage.","type":"number"},"assets":{"type":"number"}},"required":["bytes","assets"]},"document":{"type":"object","properties":{"bytes":{"description":"The files' size in bytes, as they count against the store's storage.","type":"number"},"assets":{"type":"number"}},"required":["bytes","assets"]},"other":{"type":"object","properties":{"bytes":{"description":"The files' size in bytes, as they count against the store's storage.","type":"number"},"assets":{"type":"number"}},"required":["bytes","assets"]}},"required":["video","audio","image","document","other"]},"by_enforcement":{"type":"object","properties":{"public":{"type":"object","properties":{"bytes":{"description":"The files' size in bytes, as they count against the store's storage.","type":"number"},"assets":{"type":"number"}},"required":["bytes","assets"]},"external":{"type":"object","properties":{"bytes":{"description":"The files' size in bytes, as they count against the store's storage.","type":"number"},"assets":{"type":"number"}},"required":["bytes","assets"]},"signed":{"type":"object","properties":{"bytes":{"description":"The files' size in bytes, as they count against the store's storage.","type":"number"},"assets":{"type":"number"}},"required":["bytes","assets"]}},"required":["public","external","signed"]},"by_destination":{"type":"object","properties":{"product":{"type":"object","properties":{"bytes":{"description":"The files' size in bytes, as they count against the store's storage.","type":"number"},"assets":{"type":"number"}},"required":["bytes","assets"]},"entry":{"type":"object","properties":{"bytes":{"description":"The files' size in bytes, as they count against the store's storage.","type":"number"},"assets":{"type":"number"}},"required":["bytes","assets"]},"store":{"type":"object","properties":{"bytes":{"description":"The files' size in bytes, as they count against the store's storage.","type":"number"},"assets":{"type":"number"}},"required":["bytes","assets"]},"quiz":{"type":"object","properties":{"bytes":{"description":"The files' size in bytes, as they count against the store's storage.","type":"number"},"assets":{"type":"number"}},"required":["bytes","assets"]},"certificate":{"type":"object","properties":{"bytes":{"description":"The files' size in bytes, as they count against the store's storage.","type":"number"},"assets":{"type":"number"}},"required":["bytes","assets"]},"holding":{"type":"object","properties":{"bytes":{"description":"The files' size in bytes, as they count against the store's storage.","type":"number"},"assets":{"type":"number"}},"required":["bytes","assets"]},"page":{"type":"object","properties":{"bytes":{"description":"The files' size in bytes, as they count against the store's storage.","type":"number"},"assets":{"type":"number"}},"required":["bytes","assets"]}},"required":["product","entry","store","quiz","certificate","holding","page"]},"unused":{"type":"object","properties":{"bytes":{"description":"The files' size in bytes, as they count against the store's storage.","type":"number"},"assets":{"type":"number"}},"required":["bytes","assets"]},"time_zone":{"type":"string"}},"required":["used_bytes","assets","allowance_bytes","available_bytes","by_type","by_enforcement","by_destination","unused","time_zone"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/assets/{asset}/outputs":{"get":{"operationId":"listMediaOutputs","summary":"Lists a video's or audio file's AI outputs (subtitles, transcript, summary, chapters) and where each one's generation stands.","tags":["file"],"security":[{"bearer":["file:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"asset","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Lists a video's or audio file's AI outputs (subtitles, transcript, summary, chapters) and where each one's generation stands.","content":{"application/json":{"schema":{"type":"object","properties":{"media_id":{"type":"string"},"has_track":{"description":"Whether the file holds the speech track subtitles are written from; without it, a generate prepares it first.","type":"boolean"},"outputs":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["summary","chapters","transcript","subtitles"]},"asset_id":{"type":"string"},"status":{"type":"string","x-extensible-enum":["draft","published","failed","preparing","generating"]},"has_content":{"description":"Whether content landed, which a run still generating or one that failed may keep from before.","type":"boolean"},"revision":{"description":"The file's revision the content came from, or the running generation reads.","type":"number"},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The output's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"deadline":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["kind","asset_id","status","has_content","revision","language","reason","bytes","deadline","updated_at","published_at","created_at"]}}},"required":["media_id","has_track","outputs"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/assets/{asset}/output":{"get":{"operationId":"getMediaOutput","summary":"Reads one of a video's or audio file's AI outputs with its content.","tags":["file"],"security":[{"bearer":["file:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"asset","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"kind","in":"query","required":true,"schema":{"type":"string","enum":["summary","chapters","transcript","subtitles"]}}],"responses":{"200":{"description":"Reads one of a video's or audio file's AI outputs with its content.","content":{"application/json":{"schema":{"type":"object","properties":{"content":{"anyOf":[{"type":"object","properties":{"cues":{"description":"In order of their start, their JSON at most `limits.subtitles_max_bytes` bytes.","type":"array","items":{"type":"object","properties":{"start":{"description":"Seconds from the video's start.","type":"number","minimum":0,"maximum":86400},"end":{"description":"Seconds from the video's start, after `start`.","type":"number","minimum":0,"maximum":86400},"text":{"type":"string","minLength":1,"maxLength":500}},"required":["start","end","text"]},"minItems":1,"maxItems":36000}},"required":["cues"]},{"type":"object","properties":{"text":{"description":"Paragraphs, a blank line between each.","type":"string","minLength":1,"maxLength":800000}},"required":["text"]},{"type":"object","properties":{"summary":{"type":"string","minLength":1,"maxLength":2000},"key_points":{"type":"array","items":{"type":"string","minLength":1,"maxLength":300},"maxItems":12}},"required":["summary","key_points"]},{"type":"object","properties":{"chapters":{"description":"In order of their start, the first at 0.","type":"array","items":{"type":"object","properties":{"start":{"description":"Seconds from the video's start; the first chapter's is 0.","type":"number","minimum":0,"maximum":86400},"title":{"type":"string","minLength":1,"maxLength":100}},"required":["start","title"]},"minItems":1,"maxItems":100}},"required":["chapters"]},{"type":"null"}]},"unreadable":{"description":"Whether the stored content is not what an edit may save, so `content` is null though `has_content` holds.","type":"boolean"},"truncated":{"description":"Whether `content` holds less than the stored subtitles (cues left out or texts cut), so saving it drops the rest.","type":"boolean"},"kind":{"type":"string","x-extensible-enum":["summary","chapters","transcript","subtitles"]},"asset_id":{"type":"string"},"status":{"type":"string","x-extensible-enum":["draft","published","failed","preparing","generating"]},"has_content":{"description":"Whether content landed, which a run still generating or one that failed may keep from before.","type":"boolean"},"revision":{"description":"The file's revision the content came from, or the running generation reads.","type":"number"},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The output's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"deadline":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["content","unreadable","truncated","kind","asset_id","status","has_content","revision","language","reason","bytes","deadline","updated_at","published_at","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"patch":{"operationId":"updateMediaOutput","summary":"Edits one of a video's or audio file's AI outputs: the subtitles' cues, or the transcript's, summary's or chapters' content.","tags":["file"],"security":[{"bearer":["file:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"asset","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Edits one of a video's or audio file's AI outputs: the subtitles' cues, or the transcript's, summary's or chapters' content.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["summary","chapters","transcript","subtitles"]},"asset_id":{"type":"string"},"status":{"type":"string","x-extensible-enum":["draft","published","failed","preparing","generating"]},"has_content":{"description":"Whether content landed, which a run still generating or one that failed may keep from before.","type":"boolean"},"revision":{"description":"The file's revision the content came from, or the running generation reads.","type":"number"},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The output's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"deadline":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["kind","asset_id","status","has_content","revision","language","reason","bytes","deadline","updated_at","published_at","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["summary","chapters","transcript","subtitles"]},"content":{"description":"The content the output's kind takes: `cues`, `text`, `summary` with `key_points`, or `chapters`.","anyOf":[{"type":"object","properties":{"cues":{"description":"In order of their start, their JSON at most `limits.subtitles_max_bytes` bytes.","type":"array","items":{"type":"object","properties":{"start":{"description":"Seconds from the video's start.","type":"number","minimum":0,"maximum":86400},"end":{"description":"Seconds from the video's start, after `start`.","type":"number","minimum":0,"maximum":86400},"text":{"type":"string","minLength":1,"maxLength":500}},"required":["start","end","text"],"additionalProperties":false},"minItems":1,"maxItems":36000}},"required":["cues"],"additionalProperties":false},{"type":"object","properties":{"text":{"description":"Paragraphs, a blank line between each.","type":"string","minLength":1,"maxLength":800000}},"required":["text"],"additionalProperties":false},{"type":"object","properties":{"summary":{"type":"string","minLength":1,"maxLength":2000},"key_points":{"type":"array","items":{"type":"string","minLength":1,"maxLength":300},"maxItems":12}},"required":["summary","key_points"],"additionalProperties":false},{"type":"object","properties":{"chapters":{"description":"In order of their start, the first at 0.","type":"array","items":{"type":"object","properties":{"start":{"description":"Seconds from the video's start; the first chapter's is 0.","type":"number","minimum":0,"maximum":86400},"title":{"type":"string","minLength":1,"maxLength":100}},"required":["start","title"],"additionalProperties":false},"minItems":1,"maxItems":100}},"required":["chapters"],"additionalProperties":false}]}},"required":["kind","content"],"additionalProperties":false}}}}},"delete":{"operationId":"deleteMediaOutput","summary":"Deletes one of a video's or audio file's AI outputs.","tags":["file"],"security":[{"bearer":["file:delete"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"asset","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"kind","in":"query","required":true,"schema":{"type":"string","enum":["summary","chapters","transcript","subtitles"]}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Deletes one of a video's or audio file's AI outputs.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"asset_id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["summary","chapters","transcript","subtitles"]},"deleted":{"type":"boolean","const":true}},"required":["asset_id","kind","deleted"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/assets/{asset}/outputs/generate":{"post":{"operationId":"generateMediaOutput","summary":"Generates one of a video's or audio file's AI outputs, or generates it again, landing as a draft; subtitles first, the rest from them.","tags":["file"],"security":[{"bearer":["file:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"asset","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Generates one of a video's or audio file's AI outputs, or generates it again, landing as a draft; subtitles first, the rest from them.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["summary","chapters","transcript","subtitles"]},"asset_id":{"type":"string"},"status":{"type":"string","x-extensible-enum":["draft","published","failed","preparing","generating"]},"has_content":{"description":"Whether content landed, which a run still generating or one that failed may keep from before.","type":"boolean"},"revision":{"description":"The file's revision the content came from, or the running generation reads.","type":"number"},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The output's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"deadline":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["kind","asset_id","status","has_content","revision","language","reason","bytes","deadline","updated_at","published_at","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["summary","chapters","transcript","subtitles"]}},"required":["kind"],"additionalProperties":false}}}}}},"/v1/stores/{store}/assets/{asset}/outputs/publish":{"post":{"operationId":"publishMediaOutput","summary":"Publishes one of a video's or audio file's AI outputs to customers, or takes it back to a draft.","tags":["file"],"security":[{"bearer":["file:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"asset","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Publishes one of a video's or audio file's AI outputs to customers, or takes it back to a draft.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["summary","chapters","transcript","subtitles"]},"asset_id":{"type":"string"},"status":{"type":"string","x-extensible-enum":["draft","published","failed","preparing","generating"]},"has_content":{"description":"Whether content landed, which a run still generating or one that failed may keep from before.","type":"boolean"},"revision":{"description":"The file's revision the content came from, or the running generation reads.","type":"number"},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The output's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"deadline":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["kind","asset_id","status","has_content","revision","language","reason","bytes","deadline","updated_at","published_at","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["summary","chapters","transcript","subtitles"]},"published":{"type":"boolean"}},"required":["kind","published"],"additionalProperties":false}}}}}},"/v1/stores/{store}/uploads":{"post":{"operationId":"createUpload","summary":"Reserves a file and answers where to upload its bytes. A file of at most 2 MiB can go in the call instead, through the inline upload.","tags":["file"],"security":[{"bearer":["file:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"201":{"description":"Reserves a file and answers where to upload its bytes. A file of at most 2 MiB can go in the call instead, through the inline upload.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"asset":{"type":"object","properties":{"transforms":{"type":"array","items":{"type":"object","properties":{"stage":{"type":"string","x-extensible-enum":["ingest","derive","deliver"]},"params":{"type":"object","properties":{"level":{"type":"string","x-extensible-enum":["basic","full"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"position":{"type":"number"}},"required":["stage","params","position"]}},"deliveries":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"asset_id":{"type":"string"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"member_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"intent":{"type":"string","x-extensible-enum":["preview","download","stream"]},"channel":{"type":"string","x-extensible-enum":["api","web","mcp","feed","staff"]},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"expires_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revoked_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"max_uses":{"anyOf":[{"type":"number"},{"type":"null"}]},"used_count":{"type":"number"},"used_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"type":"string","x-extensible-enum":["expired","revoked","used","unused"]}},"required":["id","asset_id","customer_id","member_id","intent","channel","issued_at","expires_at","revoked_at","max_uses","used_count","used_at","state"]}},"total":{"type":"number"}},"required":["items","total"]},"uses":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"attachment_id":{"type":"string"},"asset_id":{"type":"string"},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"target":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry","store","quiz","certificate","holding","page"]},"id":{"type":"string"}},"required":["kind","id"]},"from_body":{"type":"boolean"},"detachable":{"type":"boolean"},"release":{"description":"The software release shipping it, whether it is the current download, and the release holders download once it goes; null for a file no release ships.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"},"current":{"type":"boolean"},"after":{"description":"The release whose files holders download once this file is gone; null when none would ship any.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"}},"required":["id","version"]},{"type":"null"}]}},"required":["id","version","current","after"]},{"type":"null"}]}},"required":["attachment_id","asset_id","role","delivery","target","from_body","detachable","release"]}},"total":{"type":"number"},"detachable":{"type":"number"}},"required":["items","total","detachable"]},"children":{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"}},"total":{"type":"number"}},"required":["items","total"]},"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["transforms","deliveries","uses","children","id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]},"upload":{"type":"object","properties":{"url":{"type":"string"},"method":{"type":"string","x-extensible-enum":["PUT"]},"headers":{"type":"object","properties":{},"additionalProperties":{"type":"string"}},"expires_at":{"type":"string"}},"required":["url","method","headers","expires_at"]}},"required":["asset","upload"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"storage":{"description":"Deprecated: send `enforcement` instead.","type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false,"deprecated":true},"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^[a-z0-9][a-z0-9-]*$"},"title":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"mime":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9!#$&^_.+-]*\\/[a-zA-Z0-9][a-zA-Z0-9!#$&^_.+-]*$"},"bytes":{"description":"The file's size in bytes, as the upload sends it.","type":"integer","minimum":1,"maximum":5363466240},"ext":{"description":"The file's own extension; the mime's usual one when absent or null.","anyOf":[{"type":"string","minLength":1,"maxLength":16,"pattern":"^[a-zA-Z0-9]+$"},{"type":"null"}]},"enforcement":{"description":"How the file is served: `public` to anyone with its link, `signed` (the default) only through links that expire.","type":"string","enum":["public","signed"]}},"required":["name","mime","bytes"],"additionalProperties":false}}}}}},"/v1/stores/{store}/uploads/inline":{"post":{"operationId":"createInlineUpload","summary":"Uploads a file of at most 2 MiB with its bytes in the call, for a client that cannot send them to an upload URL.","tags":["file"],"security":[{"bearer":["file:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"201":{"description":"Uploads a file of at most 2 MiB with its bytes in the call, for a client that cannot send them to an upload URL.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"transforms":{"type":"array","items":{"type":"object","properties":{"stage":{"type":"string","x-extensible-enum":["ingest","derive","deliver"]},"params":{"type":"object","properties":{"level":{"type":"string","x-extensible-enum":["basic","full"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"position":{"type":"number"}},"required":["stage","params","position"]}},"deliveries":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"asset_id":{"type":"string"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"member_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"intent":{"type":"string","x-extensible-enum":["preview","download","stream"]},"channel":{"type":"string","x-extensible-enum":["api","web","mcp","feed","staff"]},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"expires_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revoked_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"max_uses":{"anyOf":[{"type":"number"},{"type":"null"}]},"used_count":{"type":"number"},"used_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"type":"string","x-extensible-enum":["expired","revoked","used","unused"]}},"required":["id","asset_id","customer_id","member_id","intent","channel","issued_at","expires_at","revoked_at","max_uses","used_count","used_at","state"]}},"total":{"type":"number"}},"required":["items","total"]},"uses":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"attachment_id":{"type":"string"},"asset_id":{"type":"string"},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"target":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry","store","quiz","certificate","holding","page"]},"id":{"type":"string"}},"required":["kind","id"]},"from_body":{"type":"boolean"},"detachable":{"type":"boolean"},"release":{"description":"The software release shipping it, whether it is the current download, and the release holders download once it goes; null for a file no release ships.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"},"current":{"type":"boolean"},"after":{"description":"The release whose files holders download once this file is gone; null when none would ship any.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"}},"required":["id","version"]},{"type":"null"}]}},"required":["id","version","current","after"]},{"type":"null"}]}},"required":["attachment_id","asset_id","role","delivery","target","from_body","detachable","release"]}},"total":{"type":"number"},"detachable":{"type":"number"}},"required":["items","total","detachable"]},"children":{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"}},"total":{"type":"number"}},"required":["items","total"]},"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["transforms","deliveries","uses","children","id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200,"pattern":"^[a-z0-9][a-z0-9-]*$"},"title":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"enforcement":{"description":"How the file is served: `public` to anyone with its link, `signed` (the default) only through links that expire.","type":"string","enum":["public","signed"]},"mime":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9!#$&^_.+-]*\\/[a-zA-Z0-9][a-zA-Z0-9!#$&^_.+-]*$"},"ext":{"description":"The file's own extension; the mime's usual one when absent or null.","anyOf":[{"type":"string","minLength":1,"maxLength":16,"pattern":"^[a-zA-Z0-9]+$"},{"type":"null"}]},"data":{"description":"The file's bytes, base64 in JSON, at most 2 MiB.","anyOf":[{"type":"string","contentEncoding":"base64"},{"type":"string","contentEncoding":"base64"}]}},"required":["name","mime","data"],"additionalProperties":false}}}}}},"/v1/stores/{store}/assets/{asset}/complete":{"post":{"operationId":"completeUpload","summary":"Marks an upload done once its bytes are in place.","tags":["file"],"security":[{"bearer":["file:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"asset","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Marks an upload done once its bytes are in place.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"transforms":{"type":"array","items":{"type":"object","properties":{"stage":{"type":"string","x-extensible-enum":["ingest","derive","deliver"]},"params":{"type":"object","properties":{"level":{"type":"string","x-extensible-enum":["basic","full"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"position":{"type":"number"}},"required":["stage","params","position"]}},"deliveries":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"asset_id":{"type":"string"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"member_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"intent":{"type":"string","x-extensible-enum":["preview","download","stream"]},"channel":{"type":"string","x-extensible-enum":["api","web","mcp","feed","staff"]},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"expires_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revoked_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"max_uses":{"anyOf":[{"type":"number"},{"type":"null"}]},"used_count":{"type":"number"},"used_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"type":"string","x-extensible-enum":["expired","revoked","used","unused"]}},"required":["id","asset_id","customer_id","member_id","intent","channel","issued_at","expires_at","revoked_at","max_uses","used_count","used_at","state"]}},"total":{"type":"number"}},"required":["items","total"]},"uses":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"attachment_id":{"type":"string"},"asset_id":{"type":"string"},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"target":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry","store","quiz","certificate","holding","page"]},"id":{"type":"string"}},"required":["kind","id"]},"from_body":{"type":"boolean"},"detachable":{"type":"boolean"},"release":{"description":"The software release shipping it, whether it is the current download, and the release holders download once it goes; null for a file no release ships.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"},"current":{"type":"boolean"},"after":{"description":"The release whose files holders download once this file is gone; null when none would ship any.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"}},"required":["id","version"]},{"type":"null"}]}},"required":["id","version","current","after"]},{"type":"null"}]}},"required":["attachment_id","asset_id","role","delivery","target","from_body","detachable","release"]}},"total":{"type":"number"},"detachable":{"type":"number"}},"required":["items","total","detachable"]},"children":{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"}},"total":{"type":"number"}},"required":["items","total"]},"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["transforms","deliveries","uses","children","id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}}}},"/v1/stores/{store}/assets/{asset}/cancel":{"post":{"operationId":"cancelUpload","summary":"Cancels an upload that was never completed.","tags":["file"],"security":[{"bearer":["file:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"asset","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Cancels an upload that was never completed.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean","const":true}},"required":["id","deleted"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}}}},"/v1/stores/{store}/assets/{asset}/url":{"post":{"operationId":"getAssetUrl","summary":"Mints a short-lived URL to a file's bytes.","tags":["file"],"security":[{"bearer":["file:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"asset","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Mints a short-lived URL to a file's bytes.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"expires_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["url","expires_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"disposition":{"type":"string","enum":["inline","attachment"]},"expires_in":{"type":"integer","minimum":1,"maximum":604800}},"additionalProperties":false}}}}}},"/v1/stores/{store}/assets/{asset}/move":{"post":{"operationId":"moveAsset","summary":"Moves a file between public and private storage.","tags":["file"],"security":[{"bearer":["file:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"asset","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Moves a file between public and private storage.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"transforms":{"type":"array","items":{"type":"object","properties":{"stage":{"type":"string","x-extensible-enum":["ingest","derive","deliver"]},"params":{"type":"object","properties":{"level":{"type":"string","x-extensible-enum":["basic","full"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"position":{"type":"number"}},"required":["stage","params","position"]}},"deliveries":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"asset_id":{"type":"string"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"member_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"intent":{"type":"string","x-extensible-enum":["preview","download","stream"]},"channel":{"type":"string","x-extensible-enum":["api","web","mcp","feed","staff"]},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"expires_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revoked_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"max_uses":{"anyOf":[{"type":"number"},{"type":"null"}]},"used_count":{"type":"number"},"used_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"type":"string","x-extensible-enum":["expired","revoked","used","unused"]}},"required":["id","asset_id","customer_id","member_id","intent","channel","issued_at","expires_at","revoked_at","max_uses","used_count","used_at","state"]}},"total":{"type":"number"}},"required":["items","total"]},"uses":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"attachment_id":{"type":"string"},"asset_id":{"type":"string"},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"target":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry","store","quiz","certificate","holding","page"]},"id":{"type":"string"}},"required":["kind","id"]},"from_body":{"type":"boolean"},"detachable":{"type":"boolean"},"release":{"description":"The software release shipping it, whether it is the current download, and the release holders download once it goes; null for a file no release ships.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"},"current":{"type":"boolean"},"after":{"description":"The release whose files holders download once this file is gone; null when none would ship any.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"}},"required":["id","version"]},{"type":"null"}]}},"required":["id","version","current","after"]},{"type":"null"}]}},"required":["attachment_id","asset_id","role","delivery","target","from_body","detachable","release"]}},"total":{"type":"number"},"detachable":{"type":"number"}},"required":["items","total","detachable"]},"children":{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"}},"total":{"type":"number"}},"required":["items","total"]},"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["transforms","deliveries","uses","children","id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"storage":{"description":"Deprecated: send `enforcement` instead.","type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false,"deprecated":true},"enforcement":{"description":"How the moved file is served, which every move names: `public` to anyone with its link, `signed` only through links that expire.","type":"string","enum":["public","signed"]}},"additionalProperties":false}}}}}},"/v1/stores/{store}/assets/{asset}/replace":{"post":{"operationId":"replaceAsset","summary":"Replaces a file's bytes with another upload's, keeping where it is used and deleting a video's or audio file's AI outputs.","tags":["file"],"security":[{"bearer":["file:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"asset","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Replaces a file's bytes with another upload's, keeping where it is used and deleting a video's or audio file's AI outputs.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"transforms":{"type":"array","items":{"type":"object","properties":{"stage":{"type":"string","x-extensible-enum":["ingest","derive","deliver"]},"params":{"type":"object","properties":{"level":{"type":"string","x-extensible-enum":["basic","full"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"position":{"type":"number"}},"required":["stage","params","position"]}},"deliveries":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"asset_id":{"type":"string"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"member_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"intent":{"type":"string","x-extensible-enum":["preview","download","stream"]},"channel":{"type":"string","x-extensible-enum":["api","web","mcp","feed","staff"]},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"expires_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revoked_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"max_uses":{"anyOf":[{"type":"number"},{"type":"null"}]},"used_count":{"type":"number"},"used_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"type":"string","x-extensible-enum":["expired","revoked","used","unused"]}},"required":["id","asset_id","customer_id","member_id","intent","channel","issued_at","expires_at","revoked_at","max_uses","used_count","used_at","state"]}},"total":{"type":"number"}},"required":["items","total"]},"uses":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"attachment_id":{"type":"string"},"asset_id":{"type":"string"},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"target":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry","store","quiz","certificate","holding","page"]},"id":{"type":"string"}},"required":["kind","id"]},"from_body":{"type":"boolean"},"detachable":{"type":"boolean"},"release":{"description":"The software release shipping it, whether it is the current download, and the release holders download once it goes; null for a file no release ships.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"},"current":{"type":"boolean"},"after":{"description":"The release whose files holders download once this file is gone; null when none would ship any.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"}},"required":["id","version"]},{"type":"null"}]}},"required":["id","version","current","after"]},{"type":"null"}]}},"required":["attachment_id","asset_id","role","delivery","target","from_body","detachable","release"]}},"total":{"type":"number"},"detachable":{"type":"number"}},"required":["items","total","detachable"]},"children":{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"}},"total":{"type":"number"}},"required":["items","total"]},"id":{"type":"string"},"locator":{"anyOf":[{"type":"string"},{"type":"null"}]},"origin":{"type":"string","x-extensible-enum":["uploaded","derived","internal","authored"]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes; null when it is charged nothing.","anyOf":[{"type":"number"},{"type":"null"}]},"quota_bytes":{"description":"The file's size in bytes; zero when it is charged nothing.","type":"number"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"optimized":{"type":"boolean"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"redacted":{"type":"boolean"},"security":{"anyOf":[{"type":"string","x-extensible-enum":["basic","full"]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"processed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"width":{"type":"integer","minimum":0},"height":{"type":"integer","minimum":0},"duration":{"description":"Seconds, measured, so rarely whole.","type":"number","exclusiveMinimum":0},"pages":{"type":"integer","minimum":0},"waveform":{"description":"An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.","anyOf":[{"type":"string","maxLength":344},{"type":"null"}]},"transcript":{"type":"object","properties":{"language":{"type":"string"},"confidence":{"type":"number"}}},"arguments":{"description":"What an MCP prompt asks for; only an authored prompt carries it.","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":{"type":"boolean"},"default":{"anyOf":[{"type":"string"},{"type":"null"}]},"match":{"description":"Pattern the whole value must match, diacritic-insensitive.","anyOf":[{"type":"string"},{"type":"null"}]},"flags":{"description":"Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.","anyOf":[{"type":"string"},{"type":"null"}]},"message":{"description":"What a refused value is told instead of the default reason.","anyOf":[{"type":"string"},{"type":"null"}]},"lenient":{"type":"boolean"}},"required":["name","description","required","default","match","flags","message","lenient"]}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["transforms","deliveries","uses","children","id","locator","origin","custodian","enforcement","mime","bytes","quota_bytes","name","title","ext","status","optimized","parent_id","redacted","security","description","processed_at","metadata","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"upload":{"description":"Its bytes are at most 15 MB for an image a text, a poster or a product's own `embed` shows.","type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"required":["upload"],"additionalProperties":false}}}}}},"/v1/stores/{store}/stats":{"get":{"operationId":"storeStats","summary":"Reads the store's takings and audience stats over a period.","tags":["transaction"],"security":[{"bearer":["transaction:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"from","in":"query","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","schema":{"type":"string","format":"date"}},{"name":"bucket","in":"query","schema":{"type":"string","enum":["day","week","month"]}}],"responses":{"200":{"description":"Reads the store's takings and audience stats over a period.","content":{"application/json":{"schema":{"type":"object","properties":{"store_currency":{"anyOf":[{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["currency","exponent"]},{"type":"null"}]},"orders":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"new_customers":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"active_subscriptions":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"currencies":{"type":"array","items":{"type":"object","properties":{"net":{"anyOf":[{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},{"type":"null"}]},"orders":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"series":{"type":"array","items":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"},"gross":{"anyOf":[{"type":"number"},{"type":"null"}]},"orders":{"type":"number"},"refunded":{"anyOf":[{"type":"number"},{"type":"null"}]},"platform_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"processor_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"affiliate_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"net":{"anyOf":[{"type":"number"},{"type":"null"}]},"previous_gross":{"anyOf":[{"type":"number"},{"type":"null"}]},"previous_orders":{"type":"number"},"previous_refunded":{"anyOf":[{"type":"number"},{"type":"null"}]},"previous_platform_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"previous_processor_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"previous_affiliate_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"previous_net":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["start","end","gross","orders","refunded","platform_fee","processor_fee","affiliate_fee","net","previous_gross","previous_orders","previous_refunded","previous_platform_fee","previous_processor_fee","previous_affiliate_fee","previous_net"]}},"platform_fee":{"anyOf":[{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},{"type":"null"}]},"processor_fee":{"anyOf":[{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},{"type":"null"}]},"affiliate_fee":{"anyOf":[{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},{"type":"null"}]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"gross":{"anyOf":[{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},{"type":"null"}]},"refunded":{"anyOf":[{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},{"type":"null"}]}},"required":["net","orders","series","platform_fee","processor_fee","affiliate_fee","currency","exponent","gross","refunded"]}},"bucket":{"type":"string","x-extensible-enum":["day","week","month"]},"time_zone":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"previous_range":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"]}},"required":["store_currency","orders","new_customers","active_subscriptions","currencies","bucket","time_zone","from","to","previous_range"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/orders/stats":{"get":{"operationId":"orderStats","summary":"Reads the store's order totals over a period of any length, against the span before it.","tags":["transaction"],"security":[{"bearer":["transaction:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"from","in":"query","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Reads the store's order totals over a period of any length, against the span before it.","content":{"application/json":{"schema":{"type":"object","properties":{"orders":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"currencies":{"type":"array","items":{"type":"object","properties":{"net":{"anyOf":[{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},{"type":"null"}]},"average":{"anyOf":[{"type":"object","properties":{"current":{"anyOf":[{"type":"number"},{"type":"null"}]},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},{"type":"null"}]},"platform_fee":{"anyOf":[{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},{"type":"null"}]},"processor_fee":{"anyOf":[{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},{"type":"null"}]},"affiliate_fee":{"anyOf":[{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},{"type":"null"}]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"gross":{"anyOf":[{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},{"type":"null"}]},"orders":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"refunded":{"anyOf":[{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},{"type":"null"}]}},"required":["net","average","platform_fee","processor_fee","affiliate_fee","currency","exponent","gross","orders","refunded"]}},"time_zone":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"previous_range":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"]}},"required":["orders","currencies","time_zone","from","to","previous_range"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/totals":{"get":{"operationId":"storeTotals","summary":"Reads the store's takings and audience totals since its first order.","tags":["transaction"],"security":[{"bearer":["transaction:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Reads the store's takings and audience totals since its first order.","content":{"application/json":{"schema":{"type":"object","properties":{"time_zone":{"type":"string"},"since":{"anyOf":[{"type":"string"},{"type":"null"}]},"store_currency":{"anyOf":[{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["currency","exponent"]},{"type":"null"}]},"orders":{"type":"number"},"customers":{"type":"number"},"active_subscriptions":{"type":"number"},"currencies":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"orders":{"type":"number"},"gross":{"anyOf":[{"type":"number"},{"type":"null"}]},"refunded":{"anyOf":[{"type":"number"},{"type":"null"}]},"platform_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"processor_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"affiliate_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"net":{"anyOf":[{"type":"number"},{"type":"null"}]},"average":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["currency","exponent","orders","gross","refunded","platform_fee","processor_fee","affiliate_fee","net","average"]}}},"required":["time_zone","since","store_currency","orders","customers","active_subscriptions","currencies"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/customers/stats":{"get":{"operationId":"customerStats","summary":"Reads the store's customer stats over a period.","tags":["customer"],"security":[{"bearer":["customer:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"from","in":"query","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","schema":{"type":"string","format":"date"}},{"name":"bucket","in":"query","schema":{"type":"string","enum":["day","week","month"]}}],"responses":{"200":{"description":"Reads the store's customer stats over a period.","content":{"application/json":{"schema":{"type":"object","properties":{"customers":{"type":"object","properties":{"total":{"type":"number"},"erased":{"type":"number"}},"required":["total","erased"]},"new_customers":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"returning":{"type":"object","properties":{"current":{"type":"object","properties":{"customers":{"type":"number"},"ordered":{"type":"number"}},"required":["customers","ordered"]},"previous":{"type":"object","properties":{"customers":{"type":"number"},"ordered":{"type":"number"}},"required":["customers","ordered"]}},"required":["current","previous"]},"spent":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},{"type":"null"}]},"gross":{"anyOf":[{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},{"type":"null"}]},"refunded":{"anyOf":[{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},{"type":"null"}]}},"required":["currency","exponent","amount","gross","refunded"]}},"all_time":{"type":"object","properties":{"orders":{"type":"number"},"returning":{"type":"number"},"spent":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"orders":{"type":"number"},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"gross":{"anyOf":[{"type":"number"},{"type":"null"}]},"refunded":{"anyOf":[{"type":"number"},{"type":"null"}]},"average":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["currency","exponent","orders","amount","gross","refunded","average"]}}},"required":["orders","returning","spent"]},"by_country":{"type":"array","items":{"type":"object","properties":{"orders":{"type":"number"},"currencies":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"orders":{"type":"number"},"sales":{"anyOf":[{"type":"number"},{"type":"null"}]},"average":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["currency","exponent","orders","sales","average"]}},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"customers":{"type":"number"}},"required":["orders","currencies","country","customers"]}},"series":{"type":"array","items":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"},"customers":{"type":"number"},"previous_customers":{"type":"number"}},"required":["start","end","customers","previous_customers"]}},"bucket":{"type":"string","x-extensible-enum":["day","week","month"]},"time_zone":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"previous_range":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"]}},"required":["customers","new_customers","returning","spent","all_time","by_country","series","bucket","time_zone","from","to","previous_range"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/subscriptions/stats":{"get":{"operationId":"subscriptionStats","summary":"Reads the store's subscription stats over a period.","tags":["subscription"],"security":[{"bearer":["subscription:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"from","in":"query","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","schema":{"type":"string","format":"date"}},{"name":"bucket","in":"query","schema":{"type":"string","enum":["day","week","month"]}},{"name":"product","in":"query","description":"An id.","schema":{"type":"string","minLength":1,"description":"An id."}}],"responses":{"200":{"description":"Reads the store's subscription stats over a period.","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"number"},"by_status":{"type":"object","properties":{"active":{"type":"number"},"past_due":{"type":"number"},"paused":{"type":"number"}},"required":["active","past_due","paused"]},"cancelling":{"type":"number"},"started":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"mrr":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"active":{"anyOf":[{"type":"number"},{"type":"null"}]},"at_risk":{"anyOf":[{"type":"number"},{"type":"null"}]},"ending":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["currency","exponent","active","at_risk","ending"]}},"churn":{"type":"object","properties":{"current":{"type":"object","properties":{"ended":{"type":"number"},"base":{"type":"number"}},"required":["ended","base"]},"previous":{"type":"object","properties":{"ended":{"type":"number"},"base":{"type":"number"}},"required":["ended","base"]}},"required":["current","previous"]},"series":{"type":"array","items":{"type":"object","properties":{"previous_active":{"type":"number"},"previous_past_due":{"type":"number"},"previous_paused":{"type":"number"},"start":{"type":"string"},"end":{"type":"string"},"active":{"type":"number"},"past_due":{"type":"number"},"paused":{"type":"number"}},"required":["previous_active","previous_past_due","previous_paused","start","end","active","past_due","paused"]}},"bucket":{"type":"string","x-extensible-enum":["day","week","month"]},"time_zone":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"previous_range":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"]}},"required":["total","by_status","cancelling","started","mrr","churn","series","bucket","time_zone","from","to","previous_range"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/stats":{"get":{"operationId":"productStats","summary":"Reads a product's sales and audience stats over a period.","tags":["product"],"security":[{"bearer":["product:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"from","in":"query","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","schema":{"type":"string","format":"date"}},{"name":"bucket","in":"query","schema":{"type":"string","enum":["day","week","month"]}}],"responses":{"200":{"description":"Reads a product's sales and audience stats over a period.","content":{"application/json":{"schema":{"type":"object","properties":{"rebuilding":{"type":"boolean"},"currencies":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"gross":{"anyOf":[{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},{"type":"null"}]},"refunded":{"anyOf":[{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},{"type":"null"}]},"platform_fee":{"anyOf":[{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},{"type":"null"}]},"processor_fee":{"anyOf":[{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},{"type":"null"}]},"affiliate_fee":{"anyOf":[{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},{"type":"null"}]},"net":{"anyOf":[{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},{"type":"null"}]},"transactions":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"buyers":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"refunds":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"series":{"type":"array","items":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"},"net":{"anyOf":[{"type":"number"},{"type":"null"}]},"gross":{"anyOf":[{"type":"number"},{"type":"null"}]},"buyers":{"type":"number"},"previous_net":{"anyOf":[{"type":"number"},{"type":"null"}]},"previous_gross":{"anyOf":[{"type":"number"},{"type":"null"}]},"previous_buyers":{"type":"number"}},"required":["start","end","net","gross","buyers","previous_net","previous_gross","previous_buyers"]}}},"required":["currency","exponent","gross","refunded","platform_fee","processor_fee","affiliate_fee","net","transactions","buyers","refunds","series"]}},"bucket":{"type":"string","x-extensible-enum":["day","week","month"]},"time_zone":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"previous_range":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"]}},"required":["rebuilding","currencies","bucket","time_zone","from","to","previous_range"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/stats":{"get":{"operationId":"catalogStats","summary":"Counts the store's products by status.","tags":["product"],"security":[{"bearer":["product:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Counts the store's products by status.","content":{"application/json":{"schema":{"type":"object","properties":{"products":{"type":"number"},"sales":{"type":"number"},"rating":{"type":"object","properties":{"count":{"type":"number"},"average":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["count","average"]}},"required":["products","sales","rating"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/file_stats":{"get":{"operationId":"productFileStats","summary":"Counts a product's files and links by kind.","tags":["file"],"security":[{"bearer":["file:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Counts a product's files and links by kind.","content":{"application/json":{"schema":{"type":"object","properties":{"files":{"type":"number"},"links":{"type":"number"},"bytes":{"description":"The files' size in bytes, as they count against the store's storage.","type":"number"}},"required":["files","links","bytes"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/traffic/stats":{"get":{"operationId":"trafficStats","summary":"Reads the store's views, visitors, sign-ins and sign-ups over a period, by channel, country and product, with visits by referrer, campaign and device.","tags":["transaction"],"security":[{"bearer":["transaction:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"from","in":"query","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","schema":{"type":"string","format":"date"}},{"name":"bucket","in":"query","schema":{"type":"string","enum":["day","week","month"]}}],"responses":{"200":{"description":"Reads the store's views, visitors, sign-ins and sign-ups over a period, by channel, country and product, with visits by referrer, campaign and device.","content":{"application/json":{"schema":{"type":"object","properties":{"time_zone":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"previous_range":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"]},"bucket":{"type":"string","x-extensible-enum":["day","week","month"]},"rolled_through":{"description":"The latest store-local day the totals are rolled up through, null before the first; later days count nothing yet.","anyOf":[{"type":"string"},{"type":"null"}]},"covered_from":{"description":"The earliest store-local day the totals hold, null before the first; earlier days count nothing.","anyOf":[{"type":"string"},{"type":"null"}]},"views":{"description":"Pages, products and entries shown, scaled back from sampling.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"visitors":{"description":"Unique visitors of each day, summed over the days: no visitor is followed from one day to the next, so one\nperson on three days counts three times.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"estimated":{"description":"Counted from sampled data, so the figures are estimates.","type":"boolean"},"sign_ins":{"description":"Customers signing in, a new sign-up included.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"sign_ups":{"description":"Customers signing in for the first time.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"by_event":{"type":"array","items":{"type":"object","properties":{"views":{"description":"Pages, products and entries shown, scaled back from sampling.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"visitors":{"description":"Unique visitors of each day, summed over the days: no visitor is followed from one day to the next, so one\nperson on three days counts three times.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"estimated":{"description":"Counted from sampled data, so the figures are estimates.","type":"boolean"},"event":{"type":"string","x-extensible-enum":["home_view","page_view","product_view","entry_view"]}},"required":["views","visitors","estimated","event"]}},"by_channel":{"description":"By the channel each view came through: `web`, `api`, `mcp` or `feed`.","type":"array","items":{"type":"object","properties":{"views":{"description":"Pages, products and entries shown, scaled back from sampling.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"visitors":{"description":"Unique visitors of each day, summed over the days: no visitor is followed from one day to the next, so one\nperson on three days counts three times.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"estimated":{"description":"Counted from sampled data, so the figures are estimates.","type":"boolean"},"channel":{"type":"string"}},"required":["views","visitors","estimated","channel"]}},"by_country":{"description":"By the visitor's country, null where it is unknown.","type":"array","items":{"type":"object","properties":{"views":{"description":"Pages, products and entries shown, scaled back from sampling.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"visitors":{"description":"Unique visitors of each day, summed over the days: no visitor is followed from one day to the next, so one\nperson on three days counts three times.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"estimated":{"description":"Counted from sampled data, so the figures are estimates.","type":"boolean"},"country":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["views","visitors","estimated","country"]}},"top_products":{"description":"The most viewed products in the range, and how many were viewed at all.","type":"object","properties":{"total":{"type":"number"},"covered_from":{"description":"The first day the product figures hold, which may come after `covered_from`.","anyOf":[{"type":"string"},{"type":"null"}]},"products":{"type":"array","items":{"type":"object","properties":{"views":{"description":"Pages, products and entries shown, scaled back from sampling.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"visitors":{"description":"Unique visitors of each day, summed over the days: no visitor is followed from one day to the next, so one\nperson on three days counts three times.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"estimated":{"description":"Counted from sampled data, so the figures are estimates.","type":"boolean"},"product":{"type":"object","properties":{"id":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","title"]}},"required":["views","visitors","estimated","product"]}}},"required":["total","covered_from","products"]},"series":{"type":"array","items":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"},"views":{"type":"number"},"visitors":{"type":"number"},"previous_views":{"anyOf":[{"type":"number"},{"type":"null"}]},"previous_visitors":{"anyOf":[{"type":"number"},{"type":"null"}]},"estimated":{"description":"Counted from sampled data, so the figures are estimates.","type":"boolean"}},"required":["start","end","views","visitors","previous_views","previous_visitors","estimated"]}},"sources":{"type":"object","properties":{"visits":{"description":"Visits (a visit's first page), scaled back from sampling.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"estimated":{"description":"Counted from sampled data, so the figures are estimates.","type":"boolean"},"covered_from":{"description":"The first day the visit figures hold, which may come after the answer's `covered_from`; null until one holds a visit.","anyOf":[{"type":"string"},{"type":"null"}]},"top_referrers":{"description":"The referring hosts with the most visits, direct visits as null, and how many the days' top values name, direct included.","type":"object","properties":{"total":{"type":"number"},"referrers":{"type":"array","items":{"type":"object","properties":{"visits":{"description":"Visits (a visit's first page), scaled back from sampling.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"estimated":{"description":"Counted from sampled data, so the figures are estimates.","type":"boolean"},"referrer":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["visits","estimated","referrer"]}},"other":{"description":"Visits from every referring host not listed.","type":"object","properties":{"visits":{"description":"Visits (a visit's first page), scaled back from sampling.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"estimated":{"description":"Counted from sampled data, so the figures are estimates.","type":"boolean"}},"required":["visits","estimated"]}},"required":["total","referrers","other"]},"top_campaigns":{"description":"The campaigns with the most visits, and how many the days' top values name.","type":"object","properties":{"total":{"type":"number"},"campaigns":{"type":"array","items":{"type":"object","properties":{"visits":{"description":"Visits (a visit's first page), scaled back from sampling.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"estimated":{"description":"Counted from sampled data, so the figures are estimates.","type":"boolean"},"campaign":{"type":"object","properties":{"utm_source":{"anyOf":[{"type":"string"},{"type":"null"}]},"utm_medium":{"anyOf":[{"type":"string"},{"type":"null"}]},"utm_campaign":{"anyOf":[{"type":"string"},{"type":"null"}]},"ref":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["utm_source","utm_medium","utm_campaign","ref"]}},"required":["visits","estimated","campaign"]}},"untagged":{"description":"Visits whose landing named no campaign.","type":"object","properties":{"visits":{"description":"Visits (a visit's first page), scaled back from sampling.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"estimated":{"description":"Counted from sampled data, so the figures are estimates.","type":"boolean"}},"required":["visits","estimated"]},"other":{"description":"Visits from every campaign not listed.","type":"object","properties":{"visits":{"description":"Visits (a visit's first page), scaled back from sampling.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"estimated":{"description":"Counted from sampled data, so the figures are estimates.","type":"boolean"}},"required":["visits","estimated"]}},"required":["total","campaigns","untagged","other"]},"by_device":{"description":"By the visitor's device, every one with visits: `mobile`, or `desktop` for a desktop or a tablet, null where it is unknown.","type":"array","items":{"type":"object","properties":{"visits":{"description":"Visits (a visit's first page), scaled back from sampling.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"estimated":{"description":"Counted from sampled data, so the figures are estimates.","type":"boolean"},"device":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["visits","estimated","device"]}}},"required":["visits","estimated","covered_from","top_referrers","top_campaigns","by_device"]}},"required":["time_zone","from","to","previous_range","bucket","rolled_through","covered_from","views","visitors","estimated","sign_ins","sign_ups","by_event","by_channel","by_country","top_products","series","sources"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/conversion/stats":{"get":{"operationId":"conversionStats","summary":"Reads the store's product views, checkouts started and orders over a period, by channel and product.","tags":["transaction"],"security":[{"bearer":["transaction:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"from","in":"query","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","schema":{"type":"string","format":"date"}},{"name":"bucket","in":"query","schema":{"type":"string","enum":["day","week","month"]}}],"responses":{"200":{"description":"Reads the store's product views, checkouts started and orders over a period, by channel and product.","content":{"application/json":{"schema":{"type":"object","properties":{"time_zone":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"previous_range":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"]},"bucket":{"type":"string","x-extensible-enum":["day","week","month"]},"rolled_through":{"description":"The latest store-local day the totals are rolled up through, null before the first; later days count nothing yet.","anyOf":[{"type":"string"},{"type":"null"}]},"covered_from":{"description":"The earliest store-local day the totals hold, null before the first; earlier days count nothing.","anyOf":[{"type":"string"},{"type":"null"}]},"product_views":{"description":"Products shown to customers; the merchant's own visits and other callers who are no customer are left out.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"checkouts_started":{"description":"Carts started, each counted for the product of its first line alone.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"orders":{"description":"Orders through the store's own checkout (never a renewal, nor one recorded through the API or by hand) on the\ndays the totals cover, a test purchase included.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"rates":{"description":"Rates over the steps above, which count apart, so one may reach past 1.","type":"object","properties":{"current":{"type":"object","properties":{"view_to_checkout":{"anyOf":[{"type":"number"},{"type":"null"}]},"checkout_to_order":{"anyOf":[{"type":"number"},{"type":"null"}]},"view_to_order":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["view_to_checkout","checkout_to_order","view_to_order"]},"previous":{"anyOf":[{"type":"object","properties":{"view_to_checkout":{"anyOf":[{"type":"number"},{"type":"null"}]},"checkout_to_order":{"anyOf":[{"type":"number"},{"type":"null"}]},"view_to_order":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["view_to_checkout","checkout_to_order","view_to_order"]},{"type":"null"}]}},"required":["current","previous"]},"estimated":{"description":"Views or carts counted from sampled data, so the figures are estimates.","type":"boolean"},"series":{"type":"array","items":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"},"product_views":{"type":"number"},"checkouts_started":{"type":"number"},"orders":{"type":"number"},"previous_product_views":{"anyOf":[{"type":"number"},{"type":"null"}]},"previous_checkouts_started":{"anyOf":[{"type":"number"},{"type":"null"}]},"previous_orders":{"anyOf":[{"type":"number"},{"type":"null"}]},"estimated":{"description":"Views or carts counted from sampled data, so the figures are estimates.","type":"boolean"}},"required":["start","end","product_views","checkouts_started","orders","previous_product_views","previous_checkouts_started","previous_orders","estimated"]}},"by_channel":{"description":"By the channel each step came through: orders record none, so a channel's orders are the purchases\ncompleted through it, and they need not add up to the store's orders.","type":"array","items":{"type":"object","properties":{"product_views":{"description":"Products shown to customers; the merchant's own visits and other callers who are no customer are left out.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"checkouts_started":{"description":"Carts started, each counted for the product of its first line alone.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"orders":{"description":"Orders through the store's own checkout (never a renewal, nor one recorded through the API or by hand) on the\ndays the totals cover, a test purchase included.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"rates":{"description":"Rates over the steps above, which count apart, so one may reach past 1.","type":"object","properties":{"current":{"type":"object","properties":{"view_to_checkout":{"anyOf":[{"type":"number"},{"type":"null"}]},"checkout_to_order":{"anyOf":[{"type":"number"},{"type":"null"}]},"view_to_order":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["view_to_checkout","checkout_to_order","view_to_order"]},"previous":{"anyOf":[{"type":"object","properties":{"view_to_checkout":{"anyOf":[{"type":"number"},{"type":"null"}]},"checkout_to_order":{"anyOf":[{"type":"number"},{"type":"null"}]},"view_to_order":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["view_to_checkout","checkout_to_order","view_to_order"]},{"type":"null"}]}},"required":["current","previous"]},"estimated":{"description":"Views or carts counted from sampled data, so the figures are estimates.","type":"boolean"},"channel":{"type":"string"}},"required":["product_views","checkouts_started","orders","rates","estimated","channel"]}},"by_product":{"description":"The products with the most views in the range, and how many had any step at all; an order line whose\nproduct is gone counts in `orders` alone.","type":"object","properties":{"total":{"type":"number"},"covered_from":{"description":"The first day the product figures hold, which may come after `covered_from`.","anyOf":[{"type":"string"},{"type":"null"}]},"products":{"type":"array","items":{"type":"object","properties":{"product_views":{"description":"Products shown to customers; the merchant's own visits and other callers who are no customer are left out.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"checkouts_started":{"description":"Carts started, each counted for the product of its first line alone.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"orders":{"description":"Orders through the store's own checkout (never a renewal, nor one recorded through the API or by hand) on the\ndays the totals cover, a test purchase included.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"rates":{"description":"Rates over the steps above, which count apart, so one may reach past 1.","type":"object","properties":{"current":{"type":"object","properties":{"view_to_checkout":{"anyOf":[{"type":"number"},{"type":"null"}]},"checkout_to_order":{"anyOf":[{"type":"number"},{"type":"null"}]},"view_to_order":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["view_to_checkout","checkout_to_order","view_to_order"]},"previous":{"anyOf":[{"type":"object","properties":{"view_to_checkout":{"anyOf":[{"type":"number"},{"type":"null"}]},"checkout_to_order":{"anyOf":[{"type":"number"},{"type":"null"}]},"view_to_order":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["view_to_checkout","checkout_to_order","view_to_order"]},{"type":"null"}]}},"required":["current","previous"]},"estimated":{"description":"Views or carts counted from sampled data, so the figures are estimates.","type":"boolean"},"product":{"type":"object","properties":{"id":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","title"]}},"required":["product_views","checkouts_started","orders","rates","estimated","product"]}}},"required":["total","covered_from","products"]}},"required":["time_zone","from","to","previous_range","bucket","rolled_through","covered_from","product_views","checkouts_started","orders","rates","estimated","series","by_channel","by_product"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/calls/stats":{"get":{"operationId":"callStats","summary":"Reads the calls customers' apps made to the store over the API and MCP over a period, by channel and client.","tags":["transaction"],"security":[{"bearer":["transaction:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"from","in":"query","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","schema":{"type":"string","format":"date"}},{"name":"bucket","in":"query","schema":{"type":"string","enum":["day","week","month"]}}],"responses":{"200":{"description":"Reads the calls customers' apps made to the store over the API and MCP over a period, by channel and client.","content":{"application/json":{"schema":{"type":"object","properties":{"time_zone":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"previous_range":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"]},"bucket":{"type":"string","x-extensible-enum":["day","week","month"]},"rolled_through":{"description":"The latest store-local day the totals are rolled up through, null before the first; later days count nothing yet.","anyOf":[{"type":"string"},{"type":"null"}]},"covered_from":{"description":"The earliest store-local day the totals hold, null before the first; earlier days count nothing.","anyOf":[{"type":"string"},{"type":"null"}]},"calls":{"type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"estimated":{"description":"Counted from sampled data, so the figures are estimates.","type":"boolean"},"by_channel":{"description":"By the channel: `api` or `mcp`.","type":"array","items":{"type":"object","properties":{"calls":{"type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"estimated":{"description":"Counted from sampled data, so the figures are estimates.","type":"boolean"},"channel":{"type":"string"}},"required":["calls","estimated","channel"]}},"by_client":{"description":"The clients with the most calls in the range, and how many called at all.","type":"object","properties":{"total":{"type":"number"},"clients":{"type":"array","items":{"type":"object","properties":{"calls":{"type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"estimated":{"description":"Counted from sampled data, so the figures are estimates.","type":"boolean"},"client":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name"]},"channel":{"type":"string"}},"required":["calls","estimated","client","channel"]}}},"required":["total","clients"]},"unattributed":{"description":"Calls through no client, such as a customer's own token.","type":"object","properties":{"calls":{"type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"estimated":{"description":"Counted from sampled data, so the figures are estimates.","type":"boolean"}},"required":["calls","estimated"]},"series":{"type":"array","items":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"},"calls":{"type":"number"},"previous_calls":{"anyOf":[{"type":"number"},{"type":"null"}]},"estimated":{"description":"Counted from sampled data, so the figures are estimates.","type":"boolean"}},"required":["start","end","calls","previous_calls","estimated"]}}},"required":["time_zone","from","to","previous_range","bucket","rolled_through","covered_from","calls","estimated","by_channel","by_client","unattributed","series"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/traffic/stats":{"get":{"operationId":"productTrafficStats","summary":"Reads a product's views, visitors, checkouts started and orders over a period, by channel.","tags":["product"],"security":[{"bearer":["product:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"from","in":"query","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","schema":{"type":"string","format":"date"}},{"name":"bucket","in":"query","schema":{"type":"string","enum":["day","week","month"]}}],"responses":{"200":{"description":"Reads a product's views, visitors, checkouts started and orders over a period, by channel.","content":{"application/json":{"schema":{"type":"object","properties":{"time_zone":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"previous_range":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"]},"bucket":{"type":"string","x-extensible-enum":["day","week","month"]},"rolled_through":{"description":"The latest store-local day the totals are rolled up through, null before the first; later days count nothing yet.","anyOf":[{"type":"string"},{"type":"null"}]},"covered_from":{"description":"The earliest store-local day the totals hold, null before the first; earlier days count nothing.","anyOf":[{"type":"string"},{"type":"null"}]},"product_views":{"description":"Products shown to customers; the merchant's own visits and other callers who are no customer are left out.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"checkouts_started":{"description":"Carts started, each counted for the product of its first line alone.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"orders":{"description":"Orders through the store's own checkout (never a renewal, nor one recorded through the API or by hand) on the\ndays the totals cover, a test purchase included.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"rates":{"description":"Rates over the steps above, which count apart, so one may reach past 1.","type":"object","properties":{"current":{"type":"object","properties":{"view_to_checkout":{"anyOf":[{"type":"number"},{"type":"null"}]},"checkout_to_order":{"anyOf":[{"type":"number"},{"type":"null"}]},"view_to_order":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["view_to_checkout","checkout_to_order","view_to_order"]},"previous":{"anyOf":[{"type":"object","properties":{"view_to_checkout":{"anyOf":[{"type":"number"},{"type":"null"}]},"checkout_to_order":{"anyOf":[{"type":"number"},{"type":"null"}]},"view_to_order":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["view_to_checkout","checkout_to_order","view_to_order"]},{"type":"null"}]}},"required":["current","previous"]},"estimated":{"description":"Views or carts counted from sampled data, so the figures are estimates.","type":"boolean"},"visitors":{"description":"The product's daily unique visitors, summed over the days.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"by_channel":{"description":"The product's views and visitors by the channel they came through.","type":"array","items":{"type":"object","properties":{"views":{"description":"Pages, products and entries shown, scaled back from sampling.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"visitors":{"description":"Unique visitors of each day, summed over the days: no visitor is followed from one day to the next, so one\nperson on three days counts three times.","type":"object","properties":{"current":{"type":"number"},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"]},"estimated":{"description":"Counted from sampled data, so the figures are estimates.","type":"boolean"},"channel":{"type":"string"}},"required":["views","visitors","estimated","channel"]}},"series":{"type":"array","items":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"},"product_views":{"type":"number"},"checkouts_started":{"type":"number"},"orders":{"type":"number"},"previous_product_views":{"anyOf":[{"type":"number"},{"type":"null"}]},"previous_checkouts_started":{"anyOf":[{"type":"number"},{"type":"null"}]},"previous_orders":{"anyOf":[{"type":"number"},{"type":"null"}]},"estimated":{"description":"Views or carts counted from sampled data, so the figures are estimates.","type":"boolean"},"visitors":{"type":"number"},"previous_visitors":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["start","end","product_views","checkouts_started","orders","previous_product_views","previous_checkouts_started","previous_orders","estimated","visitors","previous_visitors"]}}},"required":["time_zone","from","to","previous_range","bucket","rolled_through","covered_from","product_views","checkouts_started","orders","rates","estimated","visitors","by_channel","series"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/orders":{"get":{"operationId":"listOrders","summary":"Pages the store's orders.","tags":["transaction"],"security":[{"bearer":["transaction:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","description":"Sorted by customer or coupon, rows without a value come last either way.","schema":{"type":"string","enum":["occurred","number","amount","fees","customer","coupon"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"search","in":"query","schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"facets","in":"query","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["source"]}}}],"responses":{"200":{"description":"Pages the store's orders.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"settled":{"anyOf":[{"type":"number"},{"type":"null"}]},"refunded":{"anyOf":[{"type":"number"},{"type":"null"}]},"revocable":{"description":"Whether a revocation of the order would end anything: its customer's grants or running subscriptions on its products, or its guests' tickets.","type":"boolean"},"revocation":{"description":"The latest revocation of its access for cause; null while none.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"customer_id":{"type":"string"},"order_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"grant_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"product_ids":{"type":"array","items":{"type":"string"}},"cause":{"type":"string","x-extensible-enum":["other","terms_violation","fraud","chargeback","abuse"]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"message":{"anyOf":[{"type":"string"},{"type":"null"}]},"refund":{"anyOf":[{"type":"object","properties":{"via":{"type":"string","x-extensible-enum":["stripe","recorded"]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"settlement_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"refund_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","x-extensible-enum":["pending","failed","refunded","taken_back"]},{"type":"null"}]}},"required":["via","amount","currency","exponent","settlement_id","refund_id","status"]},{"type":"null"}]},"revoked_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","customer_id","order_id","grant_id","product_ids","cause","note","message","refund","revoked_by","token_id","created_at"]},{"type":"null"}]},"failed_revocations":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"customer_id":{"type":"string"},"order_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"grant_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"product_ids":{"type":"array","items":{"type":"string"}},"cause":{"type":"string","x-extensible-enum":["other","terms_violation","fraud","chargeback","abuse"]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"message":{"anyOf":[{"type":"string"},{"type":"null"}]},"refund":{"anyOf":[{"type":"object","properties":{"via":{"type":"string","x-extensible-enum":["stripe","recorded"]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"settlement_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"refund_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","x-extensible-enum":["pending","failed","refunded","taken_back"]},{"type":"null"}]}},"required":["via","amount","currency","exponent","settlement_id","refund_id","status"]},{"type":"null"}]},"revoked_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","customer_id","order_id","grant_id","product_ids","cause","note","message","refund","revoked_by","token_id","created_at"]}},"total":{"type":"number"}},"required":["items","total"]},"refund_status":{"description":"How much of what it settled came back: none, part or all of it; null while it settled and refunded nothing, or withheld.","anyOf":[{"type":"string","x-extensible-enum":["partial","full","none"]},{"type":"null"}]},"lines":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"guests":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","x-extensible-enum":["active","refunded","changed"]},"customer_id":{"type":"string"},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]}},"required":["id","status","customer_id","customer"]}},"revocable":{"description":"Whether a revocation of the order would end anything on the line: its customer's grant or running subscription of the product, or a guest's ticket to it.","type":"boolean"},"platform_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"processor_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"affiliate_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"refunded":{"anyOf":[{"type":"number"},{"type":"null"}]},"id":{"type":"string"},"order_id":{"type":"string"},"product_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"price_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"position":{"type":"number"},"quantity":{"type":"number"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"discount":{"anyOf":[{"type":"number"},{"type":"null"}]},"total":{"anyOf":[{"type":"number"},{"type":"null"}]},"descriptor":{"type":"object","properties":{"product":{"anyOf":[{"type":"string"},{"type":"null"}]},"price":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier":{"anyOf":[{"type":"string"},{"type":"null"}]},"coupon":{"type":"string"},"display_name":{"description":"The name and message the buyer left with a tip or a donation.","type":"string"},"message":{"type":"string"}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["product","guests","revocable","platform_fee","processor_fee","affiliate_fee","refunded","id","order_id","product_id","tier_id","price_id","position","quantity","currency","exponent","amount","discount","total","descriptor"]}},"total":{"type":"number"}},"required":["items","total"]},"settlements":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"order_id":{"type":"string"},"processor":{"anyOf":[{"type":"string","x-extensible-enum":["stripe"]},{"type":"null"}]},"processor_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"account_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"platform_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"processor_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"recorded_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","order_id","processor","processor_ref","account_ref","custodian","currency","exponent","amount","platform_fee","processor_fee","occurred_at","recorded_at"]}},"total":{"type":"number"}},"required":["items","total"]},"refunds":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"settlement_id":{"type":"string"},"order_id":{"type":"string"},"processor_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"recorded_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","settlement_id","order_id","processor_ref","amount","currency","exponent","reason","occurred_at","recorded_at"]}},"total":{"type":"number"}},"required":["items","total"]},"affiliates":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"settlement_id":{"type":"string"},"order_item_id":{"type":"string"},"order_id":{"type":"string"},"user_id":{"type":"string"},"discount_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"resolution_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["settlement_id","order_item_id","order_id","user_id","discount_id","currency","exponent","fee","resolution_id"]}},"total":{"type":"number"}},"required":["items","total"]},"id":{"type":"string"},"number":{"type":"number"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"discount":{"anyOf":[{"type":"number"},{"type":"null"}]},"total":{"anyOf":[{"type":"number"},{"type":"null"}]},"free":{"type":"boolean"},"fees":{"anyOf":[{"type":"number"},{"type":"null"}]},"source":{"type":"string","x-extensible-enum":["checkout","api","manual"]},"source_key":{"anyOf":[{"type":"string"},{"type":"null"}]},"statements":{"type":"object","properties":{"coupon":{"type":"string"},"customer_status":{"description":"How well the buyer was known; `fake` is a seeded order.","type":"string","x-extensible-enum":["anon","verified","fake"]},"method":{"description":"The payment method the processor reported.","type":"string"},"method_details":{"description":"What the method shows, as a saved instrument's display: its brand and last 4 digits.","type":"object","properties":{"brand":{"anyOf":[{"type":"string"},{"type":"null"}]},"last4":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["brand","last4"]},"refund_waiver":{"description":"Carried from the checkout.","type":"object","properties":{"policy":{"description":"The strictest policy among the lines, the one consented to.","type":"string"},"accepted_at":{"type":"string"}},"required":["policy","accepted_at"]},"under_minimum":{"type":"object","properties":{"processor":{"type":"string","const":"stripe"},"minimum":{"description":"Null when the processor refused the payment as too small rather than core reading its minimum.","anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["processor","minimum","amount"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"recorded_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["customer","settled","refunded","revocable","revocation","failed_revocations","refund_status","lines","settlements","refunds","affiliates","id","number","customer_id","currency","exponent","amount","discount","total","free","fees","source","source_key","statements","note","occurred_at","recorded_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"post":{"operationId":"recordOrder","summary":"Records an order paid outside the store, granting what it bought.","tags":["transaction"],"security":[{"bearer":["transaction:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"201":{"description":"Records an order paid outside the store, granting what it bought.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"refunds_refused":{"type":"array","items":{"type":"object","properties":{"processor_ref":{"type":"string"},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"pending":{"anyOf":[{"type":"number"},{"type":"null"}]},"refused_at":{"type":"string"}},"required":["processor_ref","amount","pending","refused_at"]}},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"settled":{"anyOf":[{"type":"number"},{"type":"null"}]},"refunded":{"anyOf":[{"type":"number"},{"type":"null"}]},"revocable":{"description":"Whether a revocation of the order would end anything: its customer's grants or running subscriptions on its products, or its guests' tickets.","type":"boolean"},"revocation":{"description":"The latest revocation of its access for cause; null while none.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"customer_id":{"type":"string"},"order_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"grant_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"product_ids":{"type":"array","items":{"type":"string"}},"cause":{"type":"string","x-extensible-enum":["other","terms_violation","fraud","chargeback","abuse"]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"message":{"anyOf":[{"type":"string"},{"type":"null"}]},"refund":{"anyOf":[{"type":"object","properties":{"via":{"type":"string","x-extensible-enum":["stripe","recorded"]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"settlement_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"refund_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","x-extensible-enum":["pending","failed","refunded","taken_back"]},{"type":"null"}]}},"required":["via","amount","currency","exponent","settlement_id","refund_id","status"]},{"type":"null"}]},"revoked_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","customer_id","order_id","grant_id","product_ids","cause","note","message","refund","revoked_by","token_id","created_at"]},{"type":"null"}]},"failed_revocations":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"customer_id":{"type":"string"},"order_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"grant_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"product_ids":{"type":"array","items":{"type":"string"}},"cause":{"type":"string","x-extensible-enum":["other","terms_violation","fraud","chargeback","abuse"]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"message":{"anyOf":[{"type":"string"},{"type":"null"}]},"refund":{"anyOf":[{"type":"object","properties":{"via":{"type":"string","x-extensible-enum":["stripe","recorded"]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"settlement_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"refund_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","x-extensible-enum":["pending","failed","refunded","taken_back"]},{"type":"null"}]}},"required":["via","amount","currency","exponent","settlement_id","refund_id","status"]},{"type":"null"}]},"revoked_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","customer_id","order_id","grant_id","product_ids","cause","note","message","refund","revoked_by","token_id","created_at"]}},"total":{"type":"number"}},"required":["items","total"]},"refund_status":{"description":"How much of what it settled came back: none, part or all of it; null while it settled and refunded nothing, or withheld.","anyOf":[{"type":"string","x-extensible-enum":["partial","full","none"]},{"type":"null"}]},"lines":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"guests":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","x-extensible-enum":["active","refunded","changed"]},"customer_id":{"type":"string"},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]}},"required":["id","status","customer_id","customer"]}},"revocable":{"description":"Whether a revocation of the order would end anything on the line: its customer's grant or running subscription of the product, or a guest's ticket to it.","type":"boolean"},"platform_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"processor_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"affiliate_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"refunded":{"anyOf":[{"type":"number"},{"type":"null"}]},"id":{"type":"string"},"order_id":{"type":"string"},"product_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"price_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"position":{"type":"number"},"quantity":{"type":"number"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"discount":{"anyOf":[{"type":"number"},{"type":"null"}]},"total":{"anyOf":[{"type":"number"},{"type":"null"}]},"descriptor":{"type":"object","properties":{"product":{"anyOf":[{"type":"string"},{"type":"null"}]},"price":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier":{"anyOf":[{"type":"string"},{"type":"null"}]},"coupon":{"type":"string"},"display_name":{"description":"The name and message the buyer left with a tip or a donation.","type":"string"},"message":{"type":"string"}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["product","guests","revocable","platform_fee","processor_fee","affiliate_fee","refunded","id","order_id","product_id","tier_id","price_id","position","quantity","currency","exponent","amount","discount","total","descriptor"]}},"total":{"type":"number"}},"required":["items","total"]},"settlements":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"order_id":{"type":"string"},"processor":{"anyOf":[{"type":"string","x-extensible-enum":["stripe"]},{"type":"null"}]},"processor_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"account_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"platform_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"processor_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"recorded_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","order_id","processor","processor_ref","account_ref","custodian","currency","exponent","amount","platform_fee","processor_fee","occurred_at","recorded_at"]}},"total":{"type":"number"}},"required":["items","total"]},"refunds":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"settlement_id":{"type":"string"},"order_id":{"type":"string"},"processor_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"recorded_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","settlement_id","order_id","processor_ref","amount","currency","exponent","reason","occurred_at","recorded_at"]}},"total":{"type":"number"}},"required":["items","total"]},"affiliates":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"settlement_id":{"type":"string"},"order_item_id":{"type":"string"},"order_id":{"type":"string"},"user_id":{"type":"string"},"discount_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"resolution_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["settlement_id","order_item_id","order_id","user_id","discount_id","currency","exponent","fee","resolution_id"]}},"total":{"type":"number"}},"required":["items","total"]},"id":{"type":"string"},"number":{"type":"number"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"discount":{"anyOf":[{"type":"number"},{"type":"null"}]},"total":{"anyOf":[{"type":"number"},{"type":"null"}]},"free":{"type":"boolean"},"fees":{"anyOf":[{"type":"number"},{"type":"null"}]},"source":{"type":"string","x-extensible-enum":["checkout","api","manual"]},"source_key":{"anyOf":[{"type":"string"},{"type":"null"}]},"statements":{"type":"object","properties":{"coupon":{"type":"string"},"customer_status":{"description":"How well the buyer was known; `fake` is a seeded order.","type":"string","x-extensible-enum":["anon","verified","fake"]},"method":{"description":"The payment method the processor reported.","type":"string"},"method_details":{"description":"What the method shows, as a saved instrument's display: its brand and last 4 digits.","type":"object","properties":{"brand":{"anyOf":[{"type":"string"},{"type":"null"}]},"last4":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["brand","last4"]},"refund_waiver":{"description":"Carried from the checkout.","type":"object","properties":{"policy":{"description":"The strictest policy among the lines, the one consented to.","type":"string"},"accepted_at":{"type":"string"}},"required":["policy","accepted_at"]},"under_minimum":{"type":"object","properties":{"processor":{"type":"string","const":"stripe"},"minimum":{"description":"Null when the processor refused the payment as too small rather than core reading its minimum.","anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["processor","minimum","amount"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"recorded_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["refunds_refused","customer","settled","refunded","revocable","revocation","failed_revocations","refund_status","lines","settlements","refunds","affiliates","id","number","customer_id","currency","exponent","amount","discount","total","free","fees","source","source_key","statements","note","occurred_at","recorded_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customer":{"description":"By id, or by email: whoever the address reaches, else its invited customer.","anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"email":{"type":"string","minLength":1,"maxLength":254,"pattern":"^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$"}},"required":["email"],"additionalProperties":false}]},"currency":{"type":"string","minLength":3,"maxLength":3,"pattern":"^[A-Za-z]{3}$"},"items":{"type":"array","items":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]},"tier":{"description":"The tier sold; the price's own when a price is named.","anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"null"}]},"price":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"null"}]},"quantity":{"type":"integer","minimum":1,"maximum":1000},"amount":{"type":"integer","minimum":0},"discount":{"description":"At most the line's amount.","type":"integer","minimum":0},"code":{"description":"The discount code the line sold with, so a rule bound to it fires.","anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"null"}]}},"required":["product","amount"],"additionalProperties":false},"minItems":1,"maxItems":100},"source_key":{"description":"The writer's own id for the sale, so a retried record is not a second order.","anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"note":{"description":"Shown to the customer with their order.","anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})(?:T(\\d{2}):(\\d{2})(?::(\\d{2})(?:\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"},{"type":"null"}]},"grants":{"description":"Whether each line grants its product from when the sale occurred; on unless said otherwise.","type":"boolean"}},"required":["customer","currency","items"],"additionalProperties":false}}}}}},"/v1/stores/{store}/orders/{order}":{"get":{"operationId":"getOrder","summary":"Reads one order.","tags":["transaction"],"security":[{"bearer":["transaction:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"order","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Reads one order.","content":{"application/json":{"schema":{"type":"object","properties":{"refunds_refused":{"type":"array","items":{"type":"object","properties":{"processor_ref":{"type":"string"},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"pending":{"anyOf":[{"type":"number"},{"type":"null"}]},"refused_at":{"type":"string"}},"required":["processor_ref","amount","pending","refused_at"]}},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"settled":{"anyOf":[{"type":"number"},{"type":"null"}]},"refunded":{"anyOf":[{"type":"number"},{"type":"null"}]},"revocable":{"description":"Whether a revocation of the order would end anything: its customer's grants or running subscriptions on its products, or its guests' tickets.","type":"boolean"},"revocation":{"description":"The latest revocation of its access for cause; null while none.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"customer_id":{"type":"string"},"order_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"grant_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"product_ids":{"type":"array","items":{"type":"string"}},"cause":{"type":"string","x-extensible-enum":["other","terms_violation","fraud","chargeback","abuse"]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"message":{"anyOf":[{"type":"string"},{"type":"null"}]},"refund":{"anyOf":[{"type":"object","properties":{"via":{"type":"string","x-extensible-enum":["stripe","recorded"]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"settlement_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"refund_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","x-extensible-enum":["pending","failed","refunded","taken_back"]},{"type":"null"}]}},"required":["via","amount","currency","exponent","settlement_id","refund_id","status"]},{"type":"null"}]},"revoked_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","customer_id","order_id","grant_id","product_ids","cause","note","message","refund","revoked_by","token_id","created_at"]},{"type":"null"}]},"failed_revocations":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"customer_id":{"type":"string"},"order_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"grant_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"product_ids":{"type":"array","items":{"type":"string"}},"cause":{"type":"string","x-extensible-enum":["other","terms_violation","fraud","chargeback","abuse"]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"message":{"anyOf":[{"type":"string"},{"type":"null"}]},"refund":{"anyOf":[{"type":"object","properties":{"via":{"type":"string","x-extensible-enum":["stripe","recorded"]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"settlement_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"refund_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","x-extensible-enum":["pending","failed","refunded","taken_back"]},{"type":"null"}]}},"required":["via","amount","currency","exponent","settlement_id","refund_id","status"]},{"type":"null"}]},"revoked_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","customer_id","order_id","grant_id","product_ids","cause","note","message","refund","revoked_by","token_id","created_at"]}},"total":{"type":"number"}},"required":["items","total"]},"refund_status":{"description":"How much of what it settled came back: none, part or all of it; null while it settled and refunded nothing, or withheld.","anyOf":[{"type":"string","x-extensible-enum":["partial","full","none"]},{"type":"null"}]},"lines":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"guests":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","x-extensible-enum":["active","refunded","changed"]},"customer_id":{"type":"string"},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]}},"required":["id","status","customer_id","customer"]}},"revocable":{"description":"Whether a revocation of the order would end anything on the line: its customer's grant or running subscription of the product, or a guest's ticket to it.","type":"boolean"},"platform_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"processor_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"affiliate_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"refunded":{"anyOf":[{"type":"number"},{"type":"null"}]},"id":{"type":"string"},"order_id":{"type":"string"},"product_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"price_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"position":{"type":"number"},"quantity":{"type":"number"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"discount":{"anyOf":[{"type":"number"},{"type":"null"}]},"total":{"anyOf":[{"type":"number"},{"type":"null"}]},"descriptor":{"type":"object","properties":{"product":{"anyOf":[{"type":"string"},{"type":"null"}]},"price":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier":{"anyOf":[{"type":"string"},{"type":"null"}]},"coupon":{"type":"string"},"display_name":{"description":"The name and message the buyer left with a tip or a donation.","type":"string"},"message":{"type":"string"}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["product","guests","revocable","platform_fee","processor_fee","affiliate_fee","refunded","id","order_id","product_id","tier_id","price_id","position","quantity","currency","exponent","amount","discount","total","descriptor"]}},"total":{"type":"number"}},"required":["items","total"]},"settlements":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"order_id":{"type":"string"},"processor":{"anyOf":[{"type":"string","x-extensible-enum":["stripe"]},{"type":"null"}]},"processor_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"account_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"platform_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"processor_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"recorded_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","order_id","processor","processor_ref","account_ref","custodian","currency","exponent","amount","platform_fee","processor_fee","occurred_at","recorded_at"]}},"total":{"type":"number"}},"required":["items","total"]},"refunds":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"settlement_id":{"type":"string"},"order_id":{"type":"string"},"processor_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"recorded_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","settlement_id","order_id","processor_ref","amount","currency","exponent","reason","occurred_at","recorded_at"]}},"total":{"type":"number"}},"required":["items","total"]},"affiliates":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"settlement_id":{"type":"string"},"order_item_id":{"type":"string"},"order_id":{"type":"string"},"user_id":{"type":"string"},"discount_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"resolution_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["settlement_id","order_item_id","order_id","user_id","discount_id","currency","exponent","fee","resolution_id"]}},"total":{"type":"number"}},"required":["items","total"]},"id":{"type":"string"},"number":{"type":"number"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"discount":{"anyOf":[{"type":"number"},{"type":"null"}]},"total":{"anyOf":[{"type":"number"},{"type":"null"}]},"free":{"type":"boolean"},"fees":{"anyOf":[{"type":"number"},{"type":"null"}]},"source":{"type":"string","x-extensible-enum":["checkout","api","manual"]},"source_key":{"anyOf":[{"type":"string"},{"type":"null"}]},"statements":{"type":"object","properties":{"coupon":{"type":"string"},"customer_status":{"description":"How well the buyer was known; `fake` is a seeded order.","type":"string","x-extensible-enum":["anon","verified","fake"]},"method":{"description":"The payment method the processor reported.","type":"string"},"method_details":{"description":"What the method shows, as a saved instrument's display: its brand and last 4 digits.","type":"object","properties":{"brand":{"anyOf":[{"type":"string"},{"type":"null"}]},"last4":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["brand","last4"]},"refund_waiver":{"description":"Carried from the checkout.","type":"object","properties":{"policy":{"description":"The strictest policy among the lines, the one consented to.","type":"string"},"accepted_at":{"type":"string"}},"required":["policy","accepted_at"]},"under_minimum":{"type":"object","properties":{"processor":{"type":"string","const":"stripe"},"minimum":{"description":"Null when the processor refused the payment as too small rather than core reading its minimum.","anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["processor","minimum","amount"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"recorded_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["refunds_refused","customer","settled","refunded","revocable","revocation","failed_revocations","refund_status","lines","settlements","refunds","affiliates","id","number","customer_id","currency","exponent","amount","discount","total","free","fees","source","source_key","statements","note","occurred_at","recorded_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/orders/{order}/items":{"get":{"operationId":"listOrderItems","summary":"Pages an order's lines.","tags":["transaction"],"security":[{"bearer":["transaction:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"order","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["line"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Pages an order's lines.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"guests":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","x-extensible-enum":["active","refunded","changed"]},"customer_id":{"type":"string"},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]}},"required":["id","status","customer_id","customer"]}},"revocable":{"description":"Whether a revocation of the order would end anything on the line: its customer's grant or running subscription of the product, or a guest's ticket to it.","type":"boolean"},"platform_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"processor_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"affiliate_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"refunded":{"anyOf":[{"type":"number"},{"type":"null"}]},"id":{"type":"string"},"order_id":{"type":"string"},"product_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"price_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"position":{"type":"number"},"quantity":{"type":"number"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"discount":{"anyOf":[{"type":"number"},{"type":"null"}]},"total":{"anyOf":[{"type":"number"},{"type":"null"}]},"descriptor":{"type":"object","properties":{"product":{"anyOf":[{"type":"string"},{"type":"null"}]},"price":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier":{"anyOf":[{"type":"string"},{"type":"null"}]},"coupon":{"type":"string"},"display_name":{"description":"The name and message the buyer left with a tip or a donation.","type":"string"},"message":{"type":"string"}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["product","guests","revocable","platform_fee","processor_fee","affiliate_fee","refunded","id","order_id","product_id","tier_id","price_id","position","quantity","currency","exponent","amount","discount","total","descriptor"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/orders/{order}/settlements":{"get":{"operationId":"listOrderSettlements","summary":"Pages an order's settlements.","tags":["transaction"],"security":[{"bearer":["transaction:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"order","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["occurred"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Pages an order's settlements.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"order_id":{"type":"string"},"processor":{"anyOf":[{"type":"string","x-extensible-enum":["stripe"]},{"type":"null"}]},"processor_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"account_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"custodian":{"type":"string","x-extensible-enum":["platform","seller","external"]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"platform_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"processor_fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"recorded_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","order_id","processor","processor_ref","account_ref","custodian","currency","exponent","amount","platform_fee","processor_fee","occurred_at","recorded_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/orders/{order}/refunds":{"get":{"operationId":"listOrderRefunds","summary":"Pages an order's refunds.","tags":["transaction"],"security":[{"bearer":["transaction:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"order","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["occurred"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Pages an order's refunds.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"allocations":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"refund_id":{"type":"string"},"order_item_id":{"type":"string"},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["currency","exponent","refund_id","order_item_id","amount"]}},"id":{"type":"string"},"settlement_id":{"type":"string"},"order_id":{"type":"string"},"processor_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"recorded_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["allocations","id","settlement_id","order_id","processor_ref","amount","currency","exponent","reason","occurred_at","recorded_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"post":{"operationId":"recordRefund","summary":"Records a refund of an order, optionally revoking what it granted.","tags":["transaction"],"security":[{"bearer":["transaction:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"order","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"201":{"description":"Records a refund of an order, optionally revoking what it granted.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"allocations":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"refund_id":{"type":"string"},"order_item_id":{"type":"string"},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["currency","exponent","refund_id","order_item_id","amount"]}},"id":{"type":"string"},"settlement_id":{"type":"string"},"order_id":{"type":"string"},"processor_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"recorded_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["allocations","id","settlement_id","order_id","processor_ref","amount","currency","exponent","reason","occurred_at","recorded_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"settlement":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"amount":{"type":"integer","minimum":1},"reason":{"anyOf":[{"type":"string","minLength":1,"maxLength":500},{"type":"null"}]},"processor_ref":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"allocations":{"type":"array","items":{"type":"object","properties":{"order_item":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"amount":{"type":"integer","minimum":0},"guests":{"description":"The guest tickets of an event's line this refund ends, each giving its seat back.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"maxItems":100}},"required":["order_item","amount"],"additionalProperties":false},"maxItems":200}},"required":["settlement","amount"],"additionalProperties":false}}}}}},"/v1/stores/{store}/orders/{order}/affiliates":{"get":{"operationId":"listOrderAffiliates","summary":"Pages the affiliate commissions an order earned.","tags":["transaction"],"security":[{"bearer":["transaction:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"order","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["commission"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Pages the affiliate commissions an order earned.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"resolution":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"user_id":{"type":"string"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"kind":{"type":"string","x-extensible-enum":["paid","void"]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"processor":{"anyOf":[{"type":"string","const":"stripe"},{"type":"null"}]},"processor_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"recorded_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","user_id","currency","exponent","kind","amount","processor","processor_ref","reason","occurred_at","recorded_at"]},{"type":"null"}]},"discount":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","code","name"]},{"type":"null"}]},"settlement_id":{"type":"string"},"order_item_id":{"type":"string"},"order_id":{"type":"string"},"user_id":{"type":"string"},"discount_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"resolution_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"user":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"type":"string"},"avatar":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","email","avatar"]},{"type":"null"}]}},"required":["resolution","discount","settlement_id","order_item_id","order_id","user_id","discount_id","currency","exponent","fee","resolution_id","user"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/checkout/simulate":{"get":{"operationId":"simulateCheckout","summary":"Prices each of a product's prices as the checkout would charge a customer, or a new one, with an optional coupon, quantity and later time, writing nothing; naming a customer needs `customer:read`, and a coupon `discount:read`.","tags":["price"],"security":[{"bearer":["price:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"customer","in":"query","description":"An id. `null` clears it.","schema":{"type":"string","minLength":1,"description":"An id. `null` clears it."}},{"name":"coupon","in":"query","description":"A discount's code, or its id, as the checkout reads a coupon.","schema":{"description":"A discount's code, or its id, as the checkout reads a coupon.","type":"string","minLength":1,"maxLength":64}},{"name":"at","in":"query","description":"When to price at; now when absent, never earlier, and a date alone is that day's start in UTC.","schema":{"description":"When to price at; now when absent, never earlier, and a date alone is that day's start in UTC.","type":"string","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})(?:T(\\d{2}):(\\d{2})(?::(\\d{2})(?:\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"}},{"name":"quantity","in":"query","description":"How many of a one-time price; one when absent.","schema":{"description":"How many of a one-time price; one when absent.","type":"integer","minimum":1,"maximum":99}}],"responses":{"200":{"description":"Prices each of a product's prices as the checkout would charge a customer, or a new one, with an optional coupon, quantity and later time, writing nothing; naming a customer needs `customer:read`, and a coupon `discount:read`.","content":{"application/json":{"schema":{"type":"object","properties":{"at":{"description":"When the prices were read at.","type":"string"},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},{"type":"null"}]},"product":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"coupon":{"anyOf":[{"type":"string"},{"type":"null"}]},"quantity":{"type":"number"},"owned":{"description":"What the customer already holds of the product, or null.","anyOf":[{"type":"object","properties":{"tier_rank":{"type":"number"},"source":{"type":"string","x-extensible-enum":["subscription","grant"]},"tier_expires_at":{"description":"When the held rank ends.","anyOf":[{"type":"string"},{"type":"null"}]},"expires_at":{"description":"When every grant has ended.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["tier_rank","source","tier_expires_at","expires_at"]},{"type":"null"}]},"prices":{"description":"Every live price, and an archived one the customer's plan still renews on, in the checkout's order.","type":"array","items":{"type":"object","properties":{"price":{"description":"The price as the product lists it.","type":"object","properties":{"id":{"type":"string"},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"rank":{"type":"number"},"name":{"type":"string"}},"required":["id","rank","name"]},{"type":"null"}]},"kind":{"type":"string","x-extensible-enum":["one_time","recurring"]},"period":{"anyOf":[{"type":"object","properties":{"unit":{"type":"string","x-extensible-enum":["day","week","month","year"]},"multiplier":{"type":"number"}},"required":["unit","multiplier"]},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"type":"number"}},"required":["id","tier","kind","period","title","currency","exponent","amount"]},"verdict":{"description":"What the checkout would charge for `quantity`, or why it would refuse the price.","anyOf":[{"type":"object","properties":{"status":{"type":"string","const":"refused"},"reason":{"type":"string","x-extensible-enum":["discontinued","coupon","archived","paused","ended","sold_out","paid_ahead","cross_currency","lower_tier","same_tier_no_gain","already_owned","approval_required","not_for_sale","one_at_a_time","request_open","too_large"]}},"required":["status","reason"]},{"type":"object","properties":{"status":{"type":"string","const":"charged"},"mode":{"type":"string","x-extensible-enum":["upgrade","purchase","renewal"]},"unit":{"type":"number"},"quantity":{"type":"number"},"total":{"type":"number"}},"required":["status","mode","unit","quantity","total"]}]},"mode":{"description":"How the checkout offers it, whatever the verdict: a purchase, an upgrade, a renewal, or null when it doesn't.","anyOf":[{"type":"string","x-extensible-enum":["upgrade","purchase","renewal"]},{"type":"null"}]},"list":{"description":"The amount before any discount or credit.","type":"number"},"discounted":{"description":"The amount after the discount that applied, coupon over automatic.","anyOf":[{"type":"number"},{"type":"null"}]},"discount":{"description":"The automatic discount and the coupon that reach the price, and which one applied; their `id`, `name` and `code` are null without `discount:read`.","type":"object","properties":{"applied":{"anyOf":[{"type":"string"},{"type":"null"}]},"automatic":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"discounted":{"type":"number"}},"required":["id","name","code","discounted"]},{"type":"null"}]},"coupon":{"anyOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"discounted":{"type":"number"}},"required":["id","name","code","discounted"]},{"type":"null"}]}},"required":["applied","automatic","coupon"]},"coupon":{"description":"The coupon's verdict on this price, or null when none was named.","anyOf":[{"type":"object","properties":{"status":{"type":"string","x-extensible-enum":["archived","ended","disabled","not_found","applied","not_discountable","not_for_price","other_currency","no_gain","not_for_renewal","not_started","used_up","not_for_customer","customer_limit"]}},"required":["status"]},{"type":"null"}]},"upgrade":{"description":"The credit for what the customer already holds of the product, or null when the price isn't an upgrade.","anyOf":[{"type":"object","properties":{"source":{"type":"string","x-extensible-enum":["subscription","lifetime"]},"from_rank":{"type":"number"},"paid":{"description":"What they paid, null without `revenue:read`.","anyOf":[{"type":"object","properties":{"gross":{"type":"number"},"refunded":{"type":"number"}},"required":["gross","refunded"]},{"type":"null"}]},"held":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"amount":{"type":"number"},"discounted":{"type":"number"}},"required":["id","amount","discounted"]},{"type":"null"}]},"credit":{"type":"number"},"effective_credit":{"type":"number"},"base":{"type":"number"},"multiplier":{"type":"number"},"multiplied":{"type":"number"},"cap":{"type":"number"},"capped":{"type":"boolean"},"free":{"type":"boolean"}},"required":["source","from_rank","paid","held","credit","effective_credit","base","multiplier","multiplied","cap","capped","free"]},{"type":"null"}]},"minimum":{"description":"The payment processor's minimum charge, and the total under it the checkout grants free.","type":"object","properties":{"amount":{"type":"number"},"approximate":{"type":"boolean"},"waived":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["amount","approximate","waived"]},"recurring":{"description":"For a plan, its first charge and what it renews at, or null for a one-time price.","anyOf":[{"type":"object","properties":{"period":{"type":"object","properties":{"unit":{"type":"string","x-extensible-enum":["day","week","month","year"]},"multiplier":{"type":"number"}},"required":["unit","multiplier"]},"first":{"anyOf":[{"type":"number"},{"type":"null"}]},"renewal":{"type":"number"},"renewal_waived":{"anyOf":[{"type":"number"},{"type":"null"}]},"autorenew":{"type":"boolean"}},"required":["period","first","renewal","renewal_waived","autorenew"]},{"type":"null"}]}},"required":["price","verdict","mode","list","discounted","discount","coupon","upgrade","minimum","recurring"]}}},"required":["at","customer","product","coupon","quantity","owned","prices"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/affiliate_payouts":{"post":{"operationId":"recordAffiliatePayout","summary":"Records a payout made to an affiliate.","tags":["affiliate"],"security":[{"bearer":["affiliate:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"201":{"description":"Records a payout made to an affiliate.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"commissions":{"type":"number"},"id":{"type":"string"},"user_id":{"type":"string"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"kind":{"type":"string","x-extensible-enum":["paid","void"]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"processor":{"anyOf":[{"type":"string","x-extensible-enum":["stripe"]},{"type":"null"}]},"processor_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"recorded_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["commissions","id","user_id","currency","exponent","kind","amount","processor","processor_ref","reason","occurred_at","recorded_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","anyOf":[{"type":"object","properties":{"user":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"currency":{"type":"string","minLength":3,"maxLength":3,"pattern":"^[A-Za-z]{3}$"},"commissions":{"description":"The commissions settled; every unresolved one of the user's in the currency when absent.","type":"array","items":{"type":"object","properties":{"settlement":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"order_item":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"required":["settlement","order_item"],"additionalProperties":false},"minItems":1,"maxItems":500},"kind":{"type":"string","const":"paid"},"amount":{"type":"integer","minimum":0},"processor":{"anyOf":[{"type":"string","const":"stripe"},{"type":"null"}]},"processor_ref":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"reason":{"anyOf":[{"type":"string","minLength":1,"maxLength":500},{"type":"null"}]}},"required":["user","currency","kind","amount"],"additionalProperties":false},{"type":"object","properties":{"user":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"currency":{"type":"string","minLength":3,"maxLength":3,"pattern":"^[A-Za-z]{3}$"},"commissions":{"description":"The commissions settled; every unresolved one of the user's in the currency when absent.","type":"array","items":{"type":"object","properties":{"settlement":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"order_item":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"required":["settlement","order_item"],"additionalProperties":false},"minItems":1,"maxItems":500},"kind":{"type":"string","const":"void"},"reason":{"type":"string","minLength":1,"maxLength":500}},"required":["user","currency","kind","reason"],"additionalProperties":false}],"properties":{}}}}}},"get":{"operationId":"listAffiliatePayouts","summary":"Pages the payouts recorded to affiliates.","tags":["affiliate"],"security":[{"bearer":["affiliate:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["occurred"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Pages the payouts recorded to affiliates.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"commissions":{"type":"number"},"fees":{"anyOf":[{"type":"number"},{"type":"null"}]},"id":{"type":"string"},"user_id":{"type":"string"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"kind":{"type":"string","x-extensible-enum":["paid","void"]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"processor":{"anyOf":[{"type":"string","x-extensible-enum":["stripe"]},{"type":"null"}]},"processor_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"recorded_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"user":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"type":"string"},"avatar":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","email","avatar"]},{"type":"null"}]}},"required":["commissions","fees","id","user_id","currency","exponent","kind","amount","processor","processor_ref","reason","occurred_at","recorded_at","user"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/commissions":{"get":{"operationId":"listCommissions","summary":"Pages the commissions affiliates earned.","tags":["affiliate"],"security":[{"bearer":["affiliate:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["occurred"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"facets","in":"query","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["status"]}}}],"responses":{"200":{"description":"Pages the commissions affiliates earned.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"settlement_id":{"type":"string"},"order_item_id":{"type":"string"},"user_id":{"type":"string"},"discount_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"fee":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["unpaid","paid","void"]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"sale":{"anyOf":[{"type":"number"},{"type":"null"}]},"sale_currency":{"type":"string"},"sale_exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"order":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"number"}},"required":["id","number"]},{"type":"null"}]},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"discount":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","code","name"]},{"type":"null"}]},"resolution":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"user_id":{"type":"string"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"kind":{"type":"string","x-extensible-enum":["paid","void"]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"processor":{"anyOf":[{"type":"string","const":"stripe"},{"type":"null"}]},"processor_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"recorded_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","user_id","currency","exponent","kind","amount","processor","processor_ref","reason","occurred_at","recorded_at"]},{"type":"null"}]},"user":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"type":"string"},"avatar":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","email","avatar"]},{"type":"null"}]}},"required":["settlement_id","order_item_id","user_id","discount_id","currency","exponent","fee","status","occurred_at","sale","sale_currency","sale_exponent","order","product","discount","resolution","user"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/commissions/stats":{"get":{"operationId":"commissionStats","summary":"Reads commission totals over a period.","tags":["affiliate"],"security":[{"bearer":["affiliate:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"from","in":"query","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","schema":{"type":"string","format":"date"}},{"name":"bucket","in":"query","schema":{"type":"string","enum":["day","week","month"]}},{"name":"user","in":"query","description":"An id.","schema":{"type":"string","minLength":1,"description":"An id."}},{"name":"discount","in":"query","description":"An id.","schema":{"type":"string","minLength":1,"description":"An id."}}],"responses":{"200":{"description":"Reads commission totals over a period.","content":{"application/json":{"schema":{"type":"object","properties":{"currencies":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"unpaid":{"anyOf":[{"type":"number"},{"type":"null"}]},"paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"voided":{"anyOf":[{"type":"number"},{"type":"null"}]},"commissions":{"type":"number"},"range_earned":{"anyOf":[{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},{"type":"null"}]},"range_commissions":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"series":{"type":"array","items":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"},"earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"commissions":{"type":"number"},"previous_earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"previous_commissions":{"type":"number"}},"required":["start","end","earned","commissions","previous_earned","previous_commissions"]}}},"required":["currency","exponent","earned","unpaid","paid","voided","commissions","range_earned","range_commissions","series"]}},"bucket":{"type":"string","x-extensible-enum":["day","week","month"]},"time_zone":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"previous_range":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"]}},"required":["currencies","bucket","time_zone","from","to","previous_range"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/discounts":{"get":{"operationId":"listDiscounts","summary":"Pages the store's discounts.","tags":["discount"],"security":[{"bearer":["discount:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","description":"Sorted by code, rows without a value come last either way.","schema":{"type":"string","enum":["created","code"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"search","in":"query","schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"facets","in":"query","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["status"]}}}],"responses":{"200":{"description":"Pages the store's discounts.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"scopes":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["product","tier","store","price"]},"product_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"price_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","kind","product_id","tier_id","price_id"]}},"total":{"type":"number"}},"required":["items","total"]},"id":{"type":"string"},"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"applies":{"type":"string","x-extensible-enum":["automatically","by_code","never"]},"status":{"type":"string","x-extensible-enum":["scheduled","archived","active","off","expired"]},"amount_off":{"type":"number"},"percent_off":{"type":"number"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"floor_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"cap_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"floor_percent":{"anyOf":[{"type":"number"},{"type":"null"}]},"priority":{"type":"number"},"supply_total":{"anyOf":[{"type":"number"},{"type":"null"}]},"supply_consumed":{"type":"number"},"supply_per_customer":{"anyOf":[{"type":"number"},{"type":"null"}]},"starts_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["scopes","id","code","name","applies","status","amount_off","percent_off","currency","exponent","floor_amount","cap_amount","floor_percent","priority","supply_total","supply_consumed","supply_per_customer","starts_at","ends_at","archived_at","created_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"post":{"operationId":"createDiscount","summary":"Creates a discount.","tags":["discount"],"security":[{"bearer":["discount:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"201":{"description":"Creates a discount.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["scheduled","archived","active","off","expired"]},"id":{"type":"string"},"priority":{"type":"number"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"applies":{"type":"string","x-extensible-enum":["automatically","by_code","never"]},"amount_off":{"type":"number"},"percent_off":{"type":"number"},"floor_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"cap_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"floor_percent":{"anyOf":[{"type":"number"},{"type":"null"}]},"supply_total":{"anyOf":[{"type":"number"},{"type":"null"}]},"supply_consumed":{"type":"number"},"supply_per_customer":{"anyOf":[{"type":"number"},{"type":"null"}]},"starts_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"customers":{"type":"array","items":{"type":"string"}},"usage":{"type":"object","properties":{"customers":{"type":"number"},"uses":{"type":"number"}},"required":["customers","uses"]},"scopes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["product","tier","store","price"]},"product_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"price_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","kind","product_id","tier_id","price_id"]}},"affiliates_ended":{"type":"object","properties":{"total":{"type":"number"}},"required":["total"]},"affiliate_earnings":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"unpaid":{"anyOf":[{"type":"number"},{"type":"null"}]},"paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"commissions":{"description":"How many earned it, voids left out, and how many are owed; counted to any reader.","type":"number"},"unpaid_commissions":{"type":"number"}},"required":["currency","exponent","earned","unpaid","paid","commissions","unpaid_commissions"]}},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"affiliates":{"type":"array","items":{"type":"object","properties":{"earnings":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"unpaid":{"anyOf":[{"type":"number"},{"type":"null"}]},"paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"commissions":{"description":"How many earned it, voids left out, and how many are owed; counted to any reader.","type":"number"},"unpaid_commissions":{"type":"number"}},"required":["currency","exponent","earned","unpaid","paid","commissions","unpaid_commissions"]}},{"type":"null"}]},"user_id":{"type":"string"},"amount_earned":{"type":"number"},"percent_earned":{"type":"number"},"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"changed_token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"prior_amount_earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"prior_percent_earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"ended_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"user":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"type":"string"},"avatar":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","email","avatar"]},{"type":"null"}]}},"required":["earnings","user_id","amount_earned","percent_earned","token_id","changed_token_id","prior_amount_earned","prior_percent_earned","ended_at","updated_at","user"]}}},"required":["name","status","id","priority","created_at","currency","code","applies","amount_off","percent_off","floor_amount","cap_amount","floor_percent","supply_total","supply_consumed","supply_per_customer","starts_at","ends_at","archived_at","customers","usage","scopes","affiliates_ended","affiliate_earnings","exponent","affiliates"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"amount_off":{"description":"Off each unit bought.","type":"integer","minimum":0},"percent_off":{"type":"integer","minimum":0,"maximum":10000},"currency":{"anyOf":[{"type":"string","minLength":3,"maxLength":3,"pattern":"^[A-Za-z]{3}$"},{"type":"null"}]},"code":{"anyOf":[{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9_-]+$"},{"type":"null"}]},"name":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"applies":{"type":"string","enum":["automatically","by_code","never"]},"priority":{"type":"integer","minimum":-1000000,"maximum":1000000},"floor_amount":{"description":"The lowest each unit's price goes.","anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"cap_amount":{"description":"At most this off each unit bought.","anyOf":[{"type":"integer","minimum":1},{"type":"null"}]},"floor_percent":{"anyOf":[{"type":"integer","minimum":0,"maximum":9999},{"type":"null"}]},"supply_total":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}]},"supply_per_customer":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}]},"starts_at":{"anyOf":[{"type":"string","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})(?:T(\\d{2}):(\\d{2})(?::(\\d{2})(?:\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"},{"type":"null"}]},"ends_at":{"anyOf":[{"type":"string","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})(?:T(\\d{2}):(\\d{2})(?::(\\d{2})(?:\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"},{"type":"null"}]},"scopes":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"store"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"product"},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]}},"required":["kind","product"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"tier"},"tier":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"required":["kind","tier"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"price"},"price":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"required":["kind","price"],"additionalProperties":false}]},"maxItems":100}},"additionalProperties":false}}}}}},"/v1/stores/{store}/discounts/{discount}":{"get":{"operationId":"getDiscount","summary":"Reads one discount.","tags":["discount"],"security":[{"bearer":["discount:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"discount","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Reads one discount.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["scheduled","archived","active","off","expired"]},"id":{"type":"string"},"priority":{"type":"number"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"applies":{"type":"string","x-extensible-enum":["automatically","by_code","never"]},"amount_off":{"type":"number"},"percent_off":{"type":"number"},"floor_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"cap_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"floor_percent":{"anyOf":[{"type":"number"},{"type":"null"}]},"supply_total":{"anyOf":[{"type":"number"},{"type":"null"}]},"supply_consumed":{"type":"number"},"supply_per_customer":{"anyOf":[{"type":"number"},{"type":"null"}]},"starts_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"customers":{"type":"array","items":{"type":"string"}},"usage":{"type":"object","properties":{"customers":{"type":"number"},"uses":{"type":"number"}},"required":["customers","uses"]},"scopes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["product","tier","store","price"]},"product_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"price_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","kind","product_id","tier_id","price_id"]}},"affiliates_ended":{"type":"object","properties":{"total":{"type":"number"}},"required":["total"]},"affiliate_earnings":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"unpaid":{"anyOf":[{"type":"number"},{"type":"null"}]},"paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"commissions":{"description":"How many earned it, voids left out, and how many are owed; counted to any reader.","type":"number"},"unpaid_commissions":{"type":"number"}},"required":["currency","exponent","earned","unpaid","paid","commissions","unpaid_commissions"]}},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"affiliates":{"type":"array","items":{"type":"object","properties":{"earnings":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"unpaid":{"anyOf":[{"type":"number"},{"type":"null"}]},"paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"commissions":{"description":"How many earned it, voids left out, and how many are owed; counted to any reader.","type":"number"},"unpaid_commissions":{"type":"number"}},"required":["currency","exponent","earned","unpaid","paid","commissions","unpaid_commissions"]}},{"type":"null"}]},"user_id":{"type":"string"},"amount_earned":{"type":"number"},"percent_earned":{"type":"number"},"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"changed_token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"prior_amount_earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"prior_percent_earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"ended_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"user":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"type":"string"},"avatar":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","email","avatar"]},{"type":"null"}]}},"required":["earnings","user_id","amount_earned","percent_earned","token_id","changed_token_id","prior_amount_earned","prior_percent_earned","ended_at","updated_at","user"]}}},"required":["name","status","id","priority","created_at","currency","code","applies","amount_off","percent_off","floor_amount","cap_amount","floor_percent","supply_total","supply_consumed","supply_per_customer","starts_at","ends_at","archived_at","customers","usage","scopes","affiliates_ended","affiliate_earnings","exponent","affiliates"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"patch":{"operationId":"updateDiscount","summary":"Updates a discount's fields.","tags":["discount"],"security":[{"bearer":["discount:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"discount","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Updates a discount's fields.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["scheduled","archived","active","off","expired"]},"id":{"type":"string"},"priority":{"type":"number"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"applies":{"type":"string","x-extensible-enum":["automatically","by_code","never"]},"amount_off":{"type":"number"},"percent_off":{"type":"number"},"floor_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"cap_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"floor_percent":{"anyOf":[{"type":"number"},{"type":"null"}]},"supply_total":{"anyOf":[{"type":"number"},{"type":"null"}]},"supply_consumed":{"type":"number"},"supply_per_customer":{"anyOf":[{"type":"number"},{"type":"null"}]},"starts_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"customers":{"type":"array","items":{"type":"string"}},"usage":{"type":"object","properties":{"customers":{"type":"number"},"uses":{"type":"number"}},"required":["customers","uses"]},"scopes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["product","tier","store","price"]},"product_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"price_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","kind","product_id","tier_id","price_id"]}},"affiliates_ended":{"type":"object","properties":{"total":{"type":"number"}},"required":["total"]},"affiliate_earnings":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"unpaid":{"anyOf":[{"type":"number"},{"type":"null"}]},"paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"commissions":{"description":"How many earned it, voids left out, and how many are owed; counted to any reader.","type":"number"},"unpaid_commissions":{"type":"number"}},"required":["currency","exponent","earned","unpaid","paid","commissions","unpaid_commissions"]}},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"affiliates":{"type":"array","items":{"type":"object","properties":{"earnings":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"unpaid":{"anyOf":[{"type":"number"},{"type":"null"}]},"paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"commissions":{"description":"How many earned it, voids left out, and how many are owed; counted to any reader.","type":"number"},"unpaid_commissions":{"type":"number"}},"required":["currency","exponent","earned","unpaid","paid","commissions","unpaid_commissions"]}},{"type":"null"}]},"user_id":{"type":"string"},"amount_earned":{"type":"number"},"percent_earned":{"type":"number"},"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"changed_token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"prior_amount_earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"prior_percent_earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"ended_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"user":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"type":"string"},"avatar":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","email","avatar"]},{"type":"null"}]}},"required":["earnings","user_id","amount_earned","percent_earned","token_id","changed_token_id","prior_amount_earned","prior_percent_earned","ended_at","updated_at","user"]}}},"required":["name","status","id","priority","created_at","currency","code","applies","amount_off","percent_off","floor_amount","cap_amount","floor_percent","supply_total","supply_consumed","supply_per_customer","starts_at","ends_at","archived_at","customers","usage","scopes","affiliates_ended","affiliate_earnings","exponent","affiliates"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"priority":{"type":"integer","minimum":-1000000,"maximum":1000000},"applies":{"type":"string","enum":["automatically","by_code","never"]},"floor_amount":{"description":"The lowest each unit's price goes.","anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"cap_amount":{"description":"At most this off each unit bought.","anyOf":[{"type":"integer","minimum":1},{"type":"null"}]},"floor_percent":{"anyOf":[{"type":"integer","minimum":0,"maximum":9999},{"type":"null"}]},"supply_total":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}]},"supply_per_customer":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}]},"starts_at":{"anyOf":[{"type":"string","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})(?:T(\\d{2}):(\\d{2})(?::(\\d{2})(?:\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"},{"type":"null"}]},"ends_at":{"anyOf":[{"type":"string","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})(?:T(\\d{2}):(\\d{2})(?::(\\d{2})(?:\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"},{"type":"null"}]}},"additionalProperties":false}}}}},"delete":{"operationId":"deleteDiscount","summary":"Deletes a discount no payable checkout, unpaid commission or automation relies on.","tags":["discount"],"security":[{"bearer":["discount:delete"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"discount","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Deletes a discount no payable checkout, unpaid commission or automation relies on.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean","const":true}},"required":["id","deleted"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/discounts/stats":{"get":{"operationId":"discountStats","summary":"Counts the store's discounts by status.","tags":["discount"],"security":[{"bearer":["discount:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Counts the store's discounts by status.","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"number"},"by_status":{"type":"object","properties":{"active":{"type":"number"},"scheduled":{"type":"number"},"off":{"type":"number"},"expired":{"type":"number"},"archived":{"type":"number"}},"required":["active","scheduled","off","expired","archived"]},"automatic":{"type":"number"},"uses":{"type":"number"},"customers":{"type":"number"}},"required":["total","by_status","automatic","uses","customers"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/discounts/{discount}/archive":{"post":{"operationId":"archiveDiscount","summary":"Stops a discount from applying while keeping it.","tags":["discount"],"security":[{"bearer":["discount:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"discount","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Stops a discount from applying while keeping it.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["scheduled","archived","active","off","expired"]},"id":{"type":"string"},"priority":{"type":"number"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"applies":{"type":"string","x-extensible-enum":["automatically","by_code","never"]},"amount_off":{"type":"number"},"percent_off":{"type":"number"},"floor_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"cap_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"floor_percent":{"anyOf":[{"type":"number"},{"type":"null"}]},"supply_total":{"anyOf":[{"type":"number"},{"type":"null"}]},"supply_consumed":{"type":"number"},"supply_per_customer":{"anyOf":[{"type":"number"},{"type":"null"}]},"starts_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"customers":{"type":"array","items":{"type":"string"}},"usage":{"type":"object","properties":{"customers":{"type":"number"},"uses":{"type":"number"}},"required":["customers","uses"]},"scopes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["product","tier","store","price"]},"product_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"price_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","kind","product_id","tier_id","price_id"]}},"affiliates_ended":{"type":"object","properties":{"total":{"type":"number"}},"required":["total"]},"affiliate_earnings":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"unpaid":{"anyOf":[{"type":"number"},{"type":"null"}]},"paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"commissions":{"description":"How many earned it, voids left out, and how many are owed; counted to any reader.","type":"number"},"unpaid_commissions":{"type":"number"}},"required":["currency","exponent","earned","unpaid","paid","commissions","unpaid_commissions"]}},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"affiliates":{"type":"array","items":{"type":"object","properties":{"earnings":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"unpaid":{"anyOf":[{"type":"number"},{"type":"null"}]},"paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"commissions":{"description":"How many earned it, voids left out, and how many are owed; counted to any reader.","type":"number"},"unpaid_commissions":{"type":"number"}},"required":["currency","exponent","earned","unpaid","paid","commissions","unpaid_commissions"]}},{"type":"null"}]},"user_id":{"type":"string"},"amount_earned":{"type":"number"},"percent_earned":{"type":"number"},"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"changed_token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"prior_amount_earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"prior_percent_earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"ended_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"user":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"type":"string"},"avatar":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","email","avatar"]},{"type":"null"}]}},"required":["earnings","user_id","amount_earned","percent_earned","token_id","changed_token_id","prior_amount_earned","prior_percent_earned","ended_at","updated_at","user"]}}},"required":["name","status","id","priority","created_at","currency","code","applies","amount_off","percent_off","floor_amount","cap_amount","floor_percent","supply_total","supply_consumed","supply_per_customer","starts_at","ends_at","archived_at","customers","usage","scopes","affiliates_ended","affiliate_earnings","exponent","affiliates"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}}}},"/v1/stores/{store}/discounts/{discount}/restore":{"post":{"operationId":"restoreDiscount","summary":"Lets an archived discount apply again.","tags":["discount"],"security":[{"bearer":["discount:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"discount","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Lets an archived discount apply again.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["scheduled","archived","active","off","expired"]},"id":{"type":"string"},"priority":{"type":"number"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"applies":{"type":"string","x-extensible-enum":["automatically","by_code","never"]},"amount_off":{"type":"number"},"percent_off":{"type":"number"},"floor_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"cap_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"floor_percent":{"anyOf":[{"type":"number"},{"type":"null"}]},"supply_total":{"anyOf":[{"type":"number"},{"type":"null"}]},"supply_consumed":{"type":"number"},"supply_per_customer":{"anyOf":[{"type":"number"},{"type":"null"}]},"starts_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"customers":{"type":"array","items":{"type":"string"}},"usage":{"type":"object","properties":{"customers":{"type":"number"},"uses":{"type":"number"}},"required":["customers","uses"]},"scopes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["product","tier","store","price"]},"product_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"price_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","kind","product_id","tier_id","price_id"]}},"affiliates_ended":{"type":"object","properties":{"total":{"type":"number"}},"required":["total"]},"affiliate_earnings":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"unpaid":{"anyOf":[{"type":"number"},{"type":"null"}]},"paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"commissions":{"description":"How many earned it, voids left out, and how many are owed; counted to any reader.","type":"number"},"unpaid_commissions":{"type":"number"}},"required":["currency","exponent","earned","unpaid","paid","commissions","unpaid_commissions"]}},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"affiliates":{"type":"array","items":{"type":"object","properties":{"earnings":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"unpaid":{"anyOf":[{"type":"number"},{"type":"null"}]},"paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"commissions":{"description":"How many earned it, voids left out, and how many are owed; counted to any reader.","type":"number"},"unpaid_commissions":{"type":"number"}},"required":["currency","exponent","earned","unpaid","paid","commissions","unpaid_commissions"]}},{"type":"null"}]},"user_id":{"type":"string"},"amount_earned":{"type":"number"},"percent_earned":{"type":"number"},"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"changed_token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"prior_amount_earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"prior_percent_earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"ended_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"user":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"type":"string"},"avatar":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","email","avatar"]},{"type":"null"}]}},"required":["earnings","user_id","amount_earned","percent_earned","token_id","changed_token_id","prior_amount_earned","prior_percent_earned","ended_at","updated_at","user"]}}},"required":["name","status","id","priority","created_at","currency","code","applies","amount_off","percent_off","floor_amount","cap_amount","floor_percent","supply_total","supply_consumed","supply_per_customer","starts_at","ends_at","archived_at","customers","usage","scopes","affiliates_ended","affiliate_earnings","exponent","affiliates"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}}}},"/v1/stores/{store}/affiliates":{"get":{"operationId":"listAffiliates","summary":"Pages the store's affiliates by discount.","tags":["affiliate"],"security":[{"bearer":["affiliate:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["updated"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Pages the store's affiliates by discount.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"earnings":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"unpaid":{"anyOf":[{"type":"number"},{"type":"null"}]},"paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"commissions":{"description":"How many earned it, voids left out, and how many are owed; counted to any reader.","type":"number"},"unpaid_commissions":{"type":"number"}},"required":["currency","exponent","earned","unpaid","paid","commissions","unpaid_commissions"]}},{"type":"null"}]},"discount":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["id","code","name","currency","exponent"]},{"type":"null"}]},"user_id":{"type":"string"},"amount_earned":{"type":"number"},"percent_earned":{"type":"number"},"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"changed_token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"prior_amount_earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"prior_percent_earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"ended_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"discount_id":{"type":"string"},"user":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"type":"string"},"avatar":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","email","avatar"]},{"type":"null"}]}},"required":["earnings","discount","user_id","amount_earned","percent_earned","token_id","changed_token_id","prior_amount_earned","prior_percent_earned","ended_at","updated_at","discount_id","user"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/discounts/{discount}/affiliates":{"put":{"operationId":"setAffiliate","summary":"Makes a user an affiliate of a discount, with their commission.","tags":["affiliate"],"security":[{"bearer":["affiliate:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"discount","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Makes a user an affiliate of a discount, with their commission.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["scheduled","archived","active","off","expired"]},"id":{"type":"string"},"priority":{"type":"number"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"applies":{"type":"string","x-extensible-enum":["automatically","by_code","never"]},"amount_off":{"type":"number"},"percent_off":{"type":"number"},"floor_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"cap_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"floor_percent":{"anyOf":[{"type":"number"},{"type":"null"}]},"supply_total":{"anyOf":[{"type":"number"},{"type":"null"}]},"supply_consumed":{"type":"number"},"supply_per_customer":{"anyOf":[{"type":"number"},{"type":"null"}]},"starts_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"customers":{"type":"array","items":{"type":"string"}},"usage":{"type":"object","properties":{"customers":{"type":"number"},"uses":{"type":"number"}},"required":["customers","uses"]},"scopes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["product","tier","store","price"]},"product_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"price_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","kind","product_id","tier_id","price_id"]}},"affiliates_ended":{"type":"object","properties":{"total":{"type":"number"}},"required":["total"]},"affiliate_earnings":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"unpaid":{"anyOf":[{"type":"number"},{"type":"null"}]},"paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"commissions":{"description":"How many earned it, voids left out, and how many are owed; counted to any reader.","type":"number"},"unpaid_commissions":{"type":"number"}},"required":["currency","exponent","earned","unpaid","paid","commissions","unpaid_commissions"]}},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"affiliates":{"type":"array","items":{"type":"object","properties":{"earnings":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"unpaid":{"anyOf":[{"type":"number"},{"type":"null"}]},"paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"commissions":{"description":"How many earned it, voids left out, and how many are owed; counted to any reader.","type":"number"},"unpaid_commissions":{"type":"number"}},"required":["currency","exponent","earned","unpaid","paid","commissions","unpaid_commissions"]}},{"type":"null"}]},"user_id":{"type":"string"},"amount_earned":{"type":"number"},"percent_earned":{"type":"number"},"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"changed_token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"prior_amount_earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"prior_percent_earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"ended_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"user":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"type":"string"},"avatar":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","email","avatar"]},{"type":"null"}]}},"required":["earnings","user_id","amount_earned","percent_earned","token_id","changed_token_id","prior_amount_earned","prior_percent_earned","ended_at","updated_at","user"]}}},"required":["name","status","id","priority","created_at","currency","code","applies","amount_off","percent_off","floor_amount","cap_amount","floor_percent","supply_total","supply_consumed","supply_per_customer","starts_at","ends_at","archived_at","customers","usage","scopes","affiliates_ended","affiliate_earnings","exponent","affiliates"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"description":"By email, or by the id of a user already an affiliate in the store.","anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"email":{"type":"string","minLength":1,"maxLength":254,"pattern":"^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$"}},"required":["email"],"additionalProperties":false}]},"amount_earned":{"description":"Paid once per order the discount reaches, never more than its lines.","type":"integer","minimum":0},"percent_earned":{"description":"Basis points of each line the discount reaches.","type":"integer","minimum":0,"maximum":10000}},"required":["user"],"additionalProperties":false}}}}}},"/v1/stores/{store}/discounts/{discount}/affiliates/remove":{"post":{"operationId":"removeAffiliate","summary":"Removes an affiliate from a discount, or ends one that earned commissions, which stay.","tags":["affiliate"],"security":[{"bearer":["affiliate:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"discount","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Removes an affiliate from a discount, or ends one that earned commissions, which stay.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["scheduled","archived","active","off","expired"]},"id":{"type":"string"},"priority":{"type":"number"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"applies":{"type":"string","x-extensible-enum":["automatically","by_code","never"]},"amount_off":{"type":"number"},"percent_off":{"type":"number"},"floor_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"cap_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"floor_percent":{"anyOf":[{"type":"number"},{"type":"null"}]},"supply_total":{"anyOf":[{"type":"number"},{"type":"null"}]},"supply_consumed":{"type":"number"},"supply_per_customer":{"anyOf":[{"type":"number"},{"type":"null"}]},"starts_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"customers":{"type":"array","items":{"type":"string"}},"usage":{"type":"object","properties":{"customers":{"type":"number"},"uses":{"type":"number"}},"required":["customers","uses"]},"scopes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["product","tier","store","price"]},"product_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"price_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","kind","product_id","tier_id","price_id"]}},"affiliates_ended":{"type":"object","properties":{"total":{"type":"number"}},"required":["total"]},"affiliate_earnings":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"unpaid":{"anyOf":[{"type":"number"},{"type":"null"}]},"paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"commissions":{"description":"How many earned it, voids left out, and how many are owed; counted to any reader.","type":"number"},"unpaid_commissions":{"type":"number"}},"required":["currency","exponent","earned","unpaid","paid","commissions","unpaid_commissions"]}},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"affiliates":{"type":"array","items":{"type":"object","properties":{"earnings":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"unpaid":{"anyOf":[{"type":"number"},{"type":"null"}]},"paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"commissions":{"description":"How many earned it, voids left out, and how many are owed; counted to any reader.","type":"number"},"unpaid_commissions":{"type":"number"}},"required":["currency","exponent","earned","unpaid","paid","commissions","unpaid_commissions"]}},{"type":"null"}]},"user_id":{"type":"string"},"amount_earned":{"type":"number"},"percent_earned":{"type":"number"},"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"changed_token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"prior_amount_earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"prior_percent_earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"ended_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"user":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"type":"string"},"avatar":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","email","avatar"]},{"type":"null"}]}},"required":["earnings","user_id","amount_earned","percent_earned","token_id","changed_token_id","prior_amount_earned","prior_percent_earned","ended_at","updated_at","user"]}}},"required":["name","status","id","priority","created_at","currency","code","applies","amount_off","percent_off","floor_amount","cap_amount","floor_percent","supply_total","supply_consumed","supply_per_customer","starts_at","ends_at","archived_at","customers","usage","scopes","affiliates_ended","affiliate_earnings","exponent","affiliates"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"required":["user"],"additionalProperties":false}}}}}},"/v1/stores/{store}/discounts/{discount}/affiliates/revert":{"post":{"operationId":"revertAffiliate","summary":"Puts back the commission an affiliate had before an API token that did not make it changed it.","tags":["affiliate"],"security":[{"bearer":["affiliate:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"discount","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Puts back the commission an affiliate had before an API token that did not make it changed it.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["scheduled","archived","active","off","expired"]},"id":{"type":"string"},"priority":{"type":"number"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"applies":{"type":"string","x-extensible-enum":["automatically","by_code","never"]},"amount_off":{"type":"number"},"percent_off":{"type":"number"},"floor_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"cap_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"floor_percent":{"anyOf":[{"type":"number"},{"type":"null"}]},"supply_total":{"anyOf":[{"type":"number"},{"type":"null"}]},"supply_consumed":{"type":"number"},"supply_per_customer":{"anyOf":[{"type":"number"},{"type":"null"}]},"starts_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"customers":{"type":"array","items":{"type":"string"}},"usage":{"type":"object","properties":{"customers":{"type":"number"},"uses":{"type":"number"}},"required":["customers","uses"]},"scopes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["product","tier","store","price"]},"product_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"price_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","kind","product_id","tier_id","price_id"]}},"affiliates_ended":{"type":"object","properties":{"total":{"type":"number"}},"required":["total"]},"affiliate_earnings":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"unpaid":{"anyOf":[{"type":"number"},{"type":"null"}]},"paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"commissions":{"description":"How many earned it, voids left out, and how many are owed; counted to any reader.","type":"number"},"unpaid_commissions":{"type":"number"}},"required":["currency","exponent","earned","unpaid","paid","commissions","unpaid_commissions"]}},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"affiliates":{"type":"array","items":{"type":"object","properties":{"earnings":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"unpaid":{"anyOf":[{"type":"number"},{"type":"null"}]},"paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"commissions":{"description":"How many earned it, voids left out, and how many are owed; counted to any reader.","type":"number"},"unpaid_commissions":{"type":"number"}},"required":["currency","exponent","earned","unpaid","paid","commissions","unpaid_commissions"]}},{"type":"null"}]},"user_id":{"type":"string"},"amount_earned":{"type":"number"},"percent_earned":{"type":"number"},"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"changed_token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"prior_amount_earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"prior_percent_earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"ended_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"user":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"type":"string"},"avatar":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","email","avatar"]},{"type":"null"}]}},"required":["earnings","user_id","amount_earned","percent_earned","token_id","changed_token_id","prior_amount_earned","prior_percent_earned","ended_at","updated_at","user"]}}},"required":["name","status","id","priority","created_at","currency","code","applies","amount_off","percent_off","floor_amount","cap_amount","floor_percent","supply_total","supply_consumed","supply_per_customer","starts_at","ends_at","archived_at","customers","usage","scopes","affiliates_ended","affiliate_earnings","exponent","affiliates"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"required":["user"],"additionalProperties":false}}}}}},"/v1/stores/{store}/discounts/{discount}/restrict":{"post":{"operationId":"restrictDiscount","summary":"Sets the products, tiers or prices a discount applies to.","tags":["discount"],"security":[{"bearer":["discount:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"discount","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Sets the products, tiers or prices a discount applies to.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["scheduled","archived","active","off","expired"]},"id":{"type":"string"},"priority":{"type":"number"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"applies":{"type":"string","x-extensible-enum":["automatically","by_code","never"]},"amount_off":{"type":"number"},"percent_off":{"type":"number"},"floor_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"cap_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"floor_percent":{"anyOf":[{"type":"number"},{"type":"null"}]},"supply_total":{"anyOf":[{"type":"number"},{"type":"null"}]},"supply_consumed":{"type":"number"},"supply_per_customer":{"anyOf":[{"type":"number"},{"type":"null"}]},"starts_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"customers":{"type":"array","items":{"type":"string"}},"usage":{"type":"object","properties":{"customers":{"type":"number"},"uses":{"type":"number"}},"required":["customers","uses"]},"scopes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["product","tier","store","price"]},"product_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"price_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","kind","product_id","tier_id","price_id"]}},"affiliates_ended":{"type":"object","properties":{"total":{"type":"number"}},"required":["total"]},"affiliate_earnings":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"unpaid":{"anyOf":[{"type":"number"},{"type":"null"}]},"paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"commissions":{"description":"How many earned it, voids left out, and how many are owed; counted to any reader.","type":"number"},"unpaid_commissions":{"type":"number"}},"required":["currency","exponent","earned","unpaid","paid","commissions","unpaid_commissions"]}},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"affiliates":{"type":"array","items":{"type":"object","properties":{"earnings":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"unpaid":{"anyOf":[{"type":"number"},{"type":"null"}]},"paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"commissions":{"description":"How many earned it, voids left out, and how many are owed; counted to any reader.","type":"number"},"unpaid_commissions":{"type":"number"}},"required":["currency","exponent","earned","unpaid","paid","commissions","unpaid_commissions"]}},{"type":"null"}]},"user_id":{"type":"string"},"amount_earned":{"type":"number"},"percent_earned":{"type":"number"},"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"changed_token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"prior_amount_earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"prior_percent_earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"ended_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"user":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"type":"string"},"avatar":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","email","avatar"]},{"type":"null"}]}},"required":["earnings","user_id","amount_earned","percent_earned","token_id","changed_token_id","prior_amount_earned","prior_percent_earned","ended_at","updated_at","user"]}}},"required":["name","status","id","priority","created_at","currency","code","applies","amount_off","percent_off","floor_amount","cap_amount","floor_percent","supply_total","supply_consumed","supply_per_customer","starts_at","ends_at","archived_at","customers","usage","scopes","affiliates_ended","affiliate_earnings","exponent","affiliates"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"maxItems":1000}},"required":["customers"],"additionalProperties":false}}}}}},"/v1/stores/{store}/discounts/{discount}/attach":{"post":{"operationId":"attachDiscount","summary":"Applies a discount to a product, tier or price.","tags":["discount"],"security":[{"bearer":["discount:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"discount","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Applies a discount to a product, tier or price.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["scheduled","archived","active","off","expired"]},"id":{"type":"string"},"priority":{"type":"number"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"applies":{"type":"string","x-extensible-enum":["automatically","by_code","never"]},"amount_off":{"type":"number"},"percent_off":{"type":"number"},"floor_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"cap_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"floor_percent":{"anyOf":[{"type":"number"},{"type":"null"}]},"supply_total":{"anyOf":[{"type":"number"},{"type":"null"}]},"supply_consumed":{"type":"number"},"supply_per_customer":{"anyOf":[{"type":"number"},{"type":"null"}]},"starts_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"customers":{"type":"array","items":{"type":"string"}},"usage":{"type":"object","properties":{"customers":{"type":"number"},"uses":{"type":"number"}},"required":["customers","uses"]},"scopes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["product","tier","store","price"]},"product_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"price_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","kind","product_id","tier_id","price_id"]}},"affiliates_ended":{"type":"object","properties":{"total":{"type":"number"}},"required":["total"]},"affiliate_earnings":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"unpaid":{"anyOf":[{"type":"number"},{"type":"null"}]},"paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"commissions":{"description":"How many earned it, voids left out, and how many are owed; counted to any reader.","type":"number"},"unpaid_commissions":{"type":"number"}},"required":["currency","exponent","earned","unpaid","paid","commissions","unpaid_commissions"]}},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"affiliates":{"type":"array","items":{"type":"object","properties":{"earnings":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"unpaid":{"anyOf":[{"type":"number"},{"type":"null"}]},"paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"commissions":{"description":"How many earned it, voids left out, and how many are owed; counted to any reader.","type":"number"},"unpaid_commissions":{"type":"number"}},"required":["currency","exponent","earned","unpaid","paid","commissions","unpaid_commissions"]}},{"type":"null"}]},"user_id":{"type":"string"},"amount_earned":{"type":"number"},"percent_earned":{"type":"number"},"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"changed_token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"prior_amount_earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"prior_percent_earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"ended_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"user":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"type":"string"},"avatar":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","email","avatar"]},{"type":"null"}]}},"required":["earnings","user_id","amount_earned","percent_earned","token_id","changed_token_id","prior_amount_earned","prior_percent_earned","ended_at","updated_at","user"]}}},"required":["name","status","id","priority","created_at","currency","code","applies","amount_off","percent_off","floor_amount","cap_amount","floor_percent","supply_total","supply_consumed","supply_per_customer","starts_at","ends_at","archived_at","customers","usage","scopes","affiliates_ended","affiliate_earnings","exponent","affiliates"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"scope":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"store"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"product"},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]}},"required":["kind","product"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"tier"},"tier":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"required":["kind","tier"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"price"},"price":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"required":["kind","price"],"additionalProperties":false}]}},"required":["scope"],"additionalProperties":false}}}}}},"/v1/stores/{store}/discounts/{discount}/detach":{"post":{"operationId":"detachDiscount","summary":"Stops a discount applying to a product, tier or price.","tags":["discount"],"security":[{"bearer":["discount:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"discount","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Stops a discount applying to a product, tier or price.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["scheduled","archived","active","off","expired"]},"id":{"type":"string"},"priority":{"type":"number"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"code":{"anyOf":[{"type":"string"},{"type":"null"}]},"applies":{"type":"string","x-extensible-enum":["automatically","by_code","never"]},"amount_off":{"type":"number"},"percent_off":{"type":"number"},"floor_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"cap_amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"floor_percent":{"anyOf":[{"type":"number"},{"type":"null"}]},"supply_total":{"anyOf":[{"type":"number"},{"type":"null"}]},"supply_consumed":{"type":"number"},"supply_per_customer":{"anyOf":[{"type":"number"},{"type":"null"}]},"starts_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"customers":{"type":"array","items":{"type":"string"}},"usage":{"type":"object","properties":{"customers":{"type":"number"},"uses":{"type":"number"}},"required":["customers","uses"]},"scopes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["product","tier","store","price"]},"product_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"price_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","kind","product_id","tier_id","price_id"]}},"affiliates_ended":{"type":"object","properties":{"total":{"type":"number"}},"required":["total"]},"affiliate_earnings":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"unpaid":{"anyOf":[{"type":"number"},{"type":"null"}]},"paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"commissions":{"description":"How many earned it, voids left out, and how many are owed; counted to any reader.","type":"number"},"unpaid_commissions":{"type":"number"}},"required":["currency","exponent","earned","unpaid","paid","commissions","unpaid_commissions"]}},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"affiliates":{"type":"array","items":{"type":"object","properties":{"earnings":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"unpaid":{"anyOf":[{"type":"number"},{"type":"null"}]},"paid":{"anyOf":[{"type":"number"},{"type":"null"}]},"commissions":{"description":"How many earned it, voids left out, and how many are owed; counted to any reader.","type":"number"},"unpaid_commissions":{"type":"number"}},"required":["currency","exponent","earned","unpaid","paid","commissions","unpaid_commissions"]}},{"type":"null"}]},"user_id":{"type":"string"},"amount_earned":{"type":"number"},"percent_earned":{"type":"number"},"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"changed_token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"prior_amount_earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"prior_percent_earned":{"anyOf":[{"type":"number"},{"type":"null"}]},"ended_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"user":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"type":"string"},"avatar":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","email","avatar"]},{"type":"null"}]}},"required":["earnings","user_id","amount_earned","percent_earned","token_id","changed_token_id","prior_amount_earned","prior_percent_earned","ended_at","updated_at","user"]}}},"required":["name","status","id","priority","created_at","currency","code","applies","amount_off","percent_off","floor_amount","cap_amount","floor_percent","supply_total","supply_consumed","supply_per_customer","starts_at","ends_at","archived_at","customers","usage","scopes","affiliates_ended","affiliate_earnings","exponent","affiliates"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"scope":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"required":["scope"],"additionalProperties":false}}}}}},"/v1/stores/{store}/subscriptions":{"get":{"operationId":"listSubscriptions","summary":"Pages the store's subscriptions.","tags":["subscription"],"security":[{"bearer":["subscription:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","description":"Sorted by ended, rows without a value come last either way.","schema":{"type":"string","enum":["created","ended","status","tier","amount"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"search","in":"query","schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"facets","in":"query","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["status"]}}}],"responses":{"200":{"description":"Pages the store's subscriptions.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"display_status":{"description":"Its status as people read it: `cancelling` while it bills and is set to stop.","type":"string","x-extensible-enum":["unpaid","active","past_due","paused","cancelled","ended","cancelling"]},"next_event":{"description":"What happens at the end of its latest paid period, as of the answer; null when nothing is ahead.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["renews","ends","lapses"]},"at":{"type":"string"}},"required":["kind","at"]},{"type":"null"}]},"actions":{"description":"The moves the store offers on it as of the answer; a write still decides again.","type":"object","properties":{"cancel":{"type":"object","properties":{"period_end":{"description":"Stopping at the period's end: it bills, is not set to stop, and its period has not ended or is not known yet.","type":"boolean"},"now":{"description":"Ending it now, revoking what it paid for.","type":"boolean"}},"required":["period_end","now"]},"resume":{"description":"Taking a stop back: it still bills and is set to stop.","type":"boolean"}},"required":["cancel","resume"]},"period_end":{"description":"When its period ends, as a cancel reads it; null for none, or once a period was refunded and none is paid.","anyOf":[{"type":"string"},{"type":"null"}]},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"plan":{"anyOf":[{"type":"object","properties":{"created_at":{"type":"string"},"id":{"type":"string"},"price_id":{"type":"string"},"amount":{"type":"number"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"period":{"type":"object","properties":{"unit":{"type":"string","x-extensible-enum":["day","week","month","year"]},"multiplier":{"type":"number"}},"required":["unit","multiplier"]},"autorenew":{"type":"boolean"}},"required":["created_at","id","price_id","amount","currency","exponent","period","autorenew"]},{"type":"null"}]},"periods":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"subscription_id":{"type":"string"},"starts_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","failed","paid","refunded"]},"lead_in":{"description":"A first period the customer's own grant covered, charged nothing; the plan's first charge pays the next.","type":"boolean"},"settlement_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"grant_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"order":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"number"}},"required":["id","number"]},{"type":"null"}]}},"required":["id","subscription_id","starts_at","ends_at","status","lead_in","settlement_id","grant_id","currency","exponent","amount","order"]}},"total":{"type":"number"}},"required":["items","total"]},"scheduled_change":{"description":"The plan it renews on from `effective_at`, the end of its paid run, as the customer scheduled; null for none.","anyOf":[{"type":"object","properties":{"plan":{"type":"object","properties":{"created_at":{"type":"string"},"id":{"type":"string"},"price_id":{"type":"string"},"amount":{"type":"number"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"period":{"type":"object","properties":{"unit":{"type":"string","x-extensible-enum":["day","week","month","year"]},"multiplier":{"type":"number"}},"required":["unit","multiplier"]},"autorenew":{"type":"boolean"}},"required":["created_at","id","price_id","amount","currency","exponent","period","autorenew"]},"effective_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["plan","effective_at"]},{"type":"null"}]},"id":{"type":"string"},"customer_id":{"type":"string"},"product_id":{"type":"string"},"plan_id":{"type":"string"},"processor":{"anyOf":[{"type":"string","x-extensible-enum":["stripe"]},{"type":"null"}]},"external_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"account_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["unpaid","active","past_due","paused","cancelled","ended"]},"cancel_at_period_end":{"type":"boolean"},"instrument_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"cancel_reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"ended_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["display_status","next_event","actions","period_end","customer","product","plan","periods","scheduled_change","id","customer_id","product_id","plan_id","processor","external_ref","account_ref","status","cancel_at_period_end","instrument_ref","cancel_reason","created_at","ended_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/subscription_periods":{"get":{"operationId":"listSubscriptionPeriods","summary":"Pages the billing periods of subscriptions.","tags":["subscription"],"security":[{"bearer":["subscription:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["billed"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Pages the billing periods of subscriptions.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"subscription_id":{"type":"string"},"starts_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","failed","paid","refunded"]},"lead_in":{"description":"A first period the customer's own grant covered, charged nothing; the plan's first charge pays the next.","type":"boolean"},"settlement_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"grant_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"order":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"number"}},"required":["id","number"]},{"type":"null"}]}},"required":["id","subscription_id","starts_at","ends_at","status","lead_in","settlement_id","grant_id","currency","exponent","amount","order"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/subscription_transitions":{"get":{"operationId":"listSubscriptionTransitions","summary":"Pages the status changes of subscriptions.","tags":["subscription"],"security":[{"bearer":["subscription:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["occurred"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Pages the status changes of subscriptions.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"subscription_id":{"type":"string"},"from_status":{"anyOf":[{"type":"string","x-extensible-enum":["unpaid","active","past_due","paused","cancelled","ended"]},{"type":"null"}]},"to_status":{"type":"string","x-extensible-enum":["unpaid","active","past_due","paused","cancelled","ended"]},"source":{"type":"string","x-extensible-enum":["customer","processor","merchant","system"]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","subscription_id","from_status","to_status","source","reason","occurred_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/subscriptions/{subscription}":{"get":{"operationId":"getSubscription","summary":"Reads one subscription.","tags":["subscription"],"security":[{"bearer":["subscription:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"subscription","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Reads one subscription.","content":{"application/json":{"schema":{"type":"object","properties":{"display_status":{"description":"Its status as people read it: `cancelling` while it bills and is set to stop.","type":"string","x-extensible-enum":["unpaid","active","past_due","paused","cancelled","ended","cancelling"]},"next_event":{"description":"What happens at the end of its latest paid period, as of the answer; null when nothing is ahead.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["renews","ends","lapses"]},"at":{"type":"string"}},"required":["kind","at"]},{"type":"null"}]},"actions":{"description":"The moves the store offers on it as of the answer; a write still decides again.","type":"object","properties":{"cancel":{"type":"object","properties":{"period_end":{"description":"Stopping at the period's end: it bills, is not set to stop, and its period has not ended or is not known yet.","type":"boolean"},"now":{"description":"Ending it now, revoking what it paid for.","type":"boolean"}},"required":["period_end","now"]},"resume":{"description":"Taking a stop back: it still bills and is set to stop.","type":"boolean"}},"required":["cancel","resume"]},"period_end":{"description":"When its period ends, as a cancel reads it; null for none, or once a period was refunded and none is paid.","anyOf":[{"type":"string"},{"type":"null"}]},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"plan":{"anyOf":[{"type":"object","properties":{"created_at":{"type":"string"},"id":{"type":"string"},"price_id":{"type":"string"},"amount":{"type":"number"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"period":{"type":"object","properties":{"unit":{"type":"string","x-extensible-enum":["day","week","month","year"]},"multiplier":{"type":"number"}},"required":["unit","multiplier"]},"autorenew":{"type":"boolean"}},"required":["created_at","id","price_id","amount","currency","exponent","period","autorenew"]},{"type":"null"}]},"periods":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"subscription_id":{"type":"string"},"starts_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","failed","paid","refunded"]},"lead_in":{"description":"A first period the customer's own grant covered, charged nothing; the plan's first charge pays the next.","type":"boolean"},"settlement_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"grant_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"order":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"number"}},"required":["id","number"]},{"type":"null"}]}},"required":["id","subscription_id","starts_at","ends_at","status","lead_in","settlement_id","grant_id","currency","exponent","amount","order"]}},"total":{"type":"number"}},"required":["items","total"]},"scheduled_change":{"description":"The plan it renews on from `effective_at`, the end of its paid run, as the customer scheduled; null for none.","anyOf":[{"type":"object","properties":{"plan":{"type":"object","properties":{"created_at":{"type":"string"},"id":{"type":"string"},"price_id":{"type":"string"},"amount":{"type":"number"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"period":{"type":"object","properties":{"unit":{"type":"string","x-extensible-enum":["day","week","month","year"]},"multiplier":{"type":"number"}},"required":["unit","multiplier"]},"autorenew":{"type":"boolean"}},"required":["created_at","id","price_id","amount","currency","exponent","period","autorenew"]},"effective_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["plan","effective_at"]},{"type":"null"}]},"id":{"type":"string"},"customer_id":{"type":"string"},"product_id":{"type":"string"},"plan_id":{"type":"string"},"processor":{"anyOf":[{"type":"string","x-extensible-enum":["stripe"]},{"type":"null"}]},"external_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"account_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["unpaid","active","past_due","paused","cancelled","ended"]},"cancel_at_period_end":{"type":"boolean"},"instrument_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"cancel_reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"ended_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["display_status","next_event","actions","period_end","customer","product","plan","periods","scheduled_change","id","customer_id","product_id","plan_id","processor","external_ref","account_ref","status","cancel_at_period_end","instrument_ref","cancel_reason","created_at","ended_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/subscriptions/{subscription}/cancel":{"post":{"operationId":"cancelSubscription","summary":"Cancels a subscription now or at the end of its period.","tags":["subscription"],"security":[{"bearer":["subscription:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"subscription","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Cancels a subscription now or at the end of its period.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"display_status":{"description":"Its status as people read it: `cancelling` while it bills and is set to stop.","type":"string","x-extensible-enum":["unpaid","active","past_due","paused","cancelled","ended","cancelling"]},"next_event":{"description":"What happens at the end of its latest paid period, as of the answer; null when nothing is ahead.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["renews","ends","lapses"]},"at":{"type":"string"}},"required":["kind","at"]},{"type":"null"}]},"actions":{"description":"The moves the store offers on it as of the answer; a write still decides again.","type":"object","properties":{"cancel":{"type":"object","properties":{"period_end":{"description":"Stopping at the period's end: it bills, is not set to stop, and its period has not ended or is not known yet.","type":"boolean"},"now":{"description":"Ending it now, revoking what it paid for.","type":"boolean"}},"required":["period_end","now"]},"resume":{"description":"Taking a stop back: it still bills and is set to stop.","type":"boolean"}},"required":["cancel","resume"]},"period_end":{"description":"When its period ends, as a cancel reads it; null for none, or once a period was refunded and none is paid.","anyOf":[{"type":"string"},{"type":"null"}]},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"plan":{"anyOf":[{"type":"object","properties":{"created_at":{"type":"string"},"id":{"type":"string"},"price_id":{"type":"string"},"amount":{"type":"number"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"period":{"type":"object","properties":{"unit":{"type":"string","x-extensible-enum":["day","week","month","year"]},"multiplier":{"type":"number"}},"required":["unit","multiplier"]},"autorenew":{"type":"boolean"}},"required":["created_at","id","price_id","amount","currency","exponent","period","autorenew"]},{"type":"null"}]},"periods":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"subscription_id":{"type":"string"},"starts_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","failed","paid","refunded"]},"lead_in":{"description":"A first period the customer's own grant covered, charged nothing; the plan's first charge pays the next.","type":"boolean"},"settlement_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"grant_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"order":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"number"}},"required":["id","number"]},{"type":"null"}]}},"required":["id","subscription_id","starts_at","ends_at","status","lead_in","settlement_id","grant_id","currency","exponent","amount","order"]}},"total":{"type":"number"}},"required":["items","total"]},"scheduled_change":{"description":"The plan it renews on from `effective_at`, the end of its paid run, as the customer scheduled; null for none.","anyOf":[{"type":"object","properties":{"plan":{"type":"object","properties":{"created_at":{"type":"string"},"id":{"type":"string"},"price_id":{"type":"string"},"amount":{"type":"number"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"period":{"type":"object","properties":{"unit":{"type":"string","x-extensible-enum":["day","week","month","year"]},"multiplier":{"type":"number"}},"required":["unit","multiplier"]},"autorenew":{"type":"boolean"}},"required":["created_at","id","price_id","amount","currency","exponent","period","autorenew"]},"effective_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["plan","effective_at"]},{"type":"null"}]},"id":{"type":"string"},"customer_id":{"type":"string"},"product_id":{"type":"string"},"plan_id":{"type":"string"},"processor":{"anyOf":[{"type":"string","x-extensible-enum":["stripe"]},{"type":"null"}]},"external_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"account_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["unpaid","active","past_due","paused","cancelled","ended"]},"cancel_at_period_end":{"type":"boolean"},"instrument_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"cancel_reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"ended_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["display_status","next_event","actions","period_end","customer","product","plan","periods","scheduled_change","id","customer_id","product_id","plan_id","processor","external_ref","account_ref","status","cancel_at_period_end","instrument_ref","cancel_reason","created_at","ended_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"when":{"type":"string","enum":["now","period_end"]},"reason":{"description":"Why, in your own words; one of the codes the store writes itself as a reason (`refund`, `dispute`, `upgraded`, `account_erased`, `Ended by the seller.` and the like) is refused.","anyOf":[{"type":"string","minLength":1,"maxLength":500},{"type":"null"}]}},"required":["when"],"additionalProperties":false}}}}}},"/v1/stores/{store}/subscriptions/{subscription}/resume":{"post":{"operationId":"resumeSubscription","summary":"Withdraws a subscription's scheduled cancellation.","tags":["subscription"],"security":[{"bearer":["subscription:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"subscription","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Withdraws a subscription's scheduled cancellation.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"display_status":{"description":"Its status as people read it: `cancelling` while it bills and is set to stop.","type":"string","x-extensible-enum":["unpaid","active","past_due","paused","cancelled","ended","cancelling"]},"next_event":{"description":"What happens at the end of its latest paid period, as of the answer; null when nothing is ahead.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["renews","ends","lapses"]},"at":{"type":"string"}},"required":["kind","at"]},{"type":"null"}]},"actions":{"description":"The moves the store offers on it as of the answer; a write still decides again.","type":"object","properties":{"cancel":{"type":"object","properties":{"period_end":{"description":"Stopping at the period's end: it bills, is not set to stop, and its period has not ended or is not known yet.","type":"boolean"},"now":{"description":"Ending it now, revoking what it paid for.","type":"boolean"}},"required":["period_end","now"]},"resume":{"description":"Taking a stop back: it still bills and is set to stop.","type":"boolean"}},"required":["cancel","resume"]},"period_end":{"description":"When its period ends, as a cancel reads it; null for none, or once a period was refunded and none is paid.","anyOf":[{"type":"string"},{"type":"null"}]},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"plan":{"anyOf":[{"type":"object","properties":{"created_at":{"type":"string"},"id":{"type":"string"},"price_id":{"type":"string"},"amount":{"type":"number"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"period":{"type":"object","properties":{"unit":{"type":"string","x-extensible-enum":["day","week","month","year"]},"multiplier":{"type":"number"}},"required":["unit","multiplier"]},"autorenew":{"type":"boolean"}},"required":["created_at","id","price_id","amount","currency","exponent","period","autorenew"]},{"type":"null"}]},"periods":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"subscription_id":{"type":"string"},"starts_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","failed","paid","refunded"]},"lead_in":{"description":"A first period the customer's own grant covered, charged nothing; the plan's first charge pays the next.","type":"boolean"},"settlement_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"grant_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"order":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"number"}},"required":["id","number"]},{"type":"null"}]}},"required":["id","subscription_id","starts_at","ends_at","status","lead_in","settlement_id","grant_id","currency","exponent","amount","order"]}},"total":{"type":"number"}},"required":["items","total"]},"scheduled_change":{"description":"The plan it renews on from `effective_at`, the end of its paid run, as the customer scheduled; null for none.","anyOf":[{"type":"object","properties":{"plan":{"type":"object","properties":{"created_at":{"type":"string"},"id":{"type":"string"},"price_id":{"type":"string"},"amount":{"type":"number"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"period":{"type":"object","properties":{"unit":{"type":"string","x-extensible-enum":["day","week","month","year"]},"multiplier":{"type":"number"}},"required":["unit","multiplier"]},"autorenew":{"type":"boolean"}},"required":["created_at","id","price_id","amount","currency","exponent","period","autorenew"]},"effective_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["plan","effective_at"]},{"type":"null"}]},"id":{"type":"string"},"customer_id":{"type":"string"},"product_id":{"type":"string"},"plan_id":{"type":"string"},"processor":{"anyOf":[{"type":"string","x-extensible-enum":["stripe"]},{"type":"null"}]},"external_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"account_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["unpaid","active","past_due","paused","cancelled","ended"]},"cancel_at_period_end":{"type":"boolean"},"instrument_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"cancel_reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"ended_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["display_status","next_event","actions","period_end","customer","product","plan","periods","scheduled_change","id","customer_id","product_id","plan_id","processor","external_ref","account_ref","status","cancel_at_period_end","instrument_ref","cancel_reason","created_at","ended_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}}}},"/v1/stores/{store}/grants":{"get":{"operationId":"listGrants","summary":"Pages the grants of access to customers.","tags":["customer"],"security":[{"bearer":["customer:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["valid_from"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"facets","in":"query","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["revoked","live"]}}}],"responses":{"200":{"description":"Pages the grants of access to customers.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},{"type":"null"}]},"id":{"type":"string"},"customer_id":{"type":"string"},"product_id":{"type":"string"},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"source_kind":{"type":"string","x-extensible-enum":["checkout","api","manual","subscription","payment","automation"]},"source_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"grant_reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"settlement_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"valid_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"end_reason":{"anyOf":[{"type":"string","x-extensible-enum":["manual","lapse","refund"]},{"type":"null"}]},"status":{"description":"Where it stands now: not begun, standing, or how it ended.","type":"string","x-extensible-enum":["scheduled","active","expired","ended","revoked","refunded"]},"revocable":{"description":"Whether `revokeGrant` may still end it.","type":"boolean"},"granted_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"recorded_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["token_id","customer","product","tier","id","customer_id","product_id","tier_id","source_kind","source_ref","grant_reason","settlement_id","valid_from","ends_at","end_reason","status","revocable","granted_by","occurred_at","recorded_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"post":{"operationId":"grantAccess","summary":"Grants a customer access to a product or tier.","tags":["customer"],"security":[{"bearer":["customer:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Grants a customer access to a product or tier.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},{"type":"null"}]},"id":{"type":"string"},"customer_id":{"type":"string"},"product_id":{"type":"string"},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"source_kind":{"type":"string","x-extensible-enum":["checkout","api","manual","subscription","payment","automation"]},"source_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"grant_reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"settlement_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"valid_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"end_reason":{"anyOf":[{"type":"string","x-extensible-enum":["manual","lapse","refund"]},{"type":"null"}]},"status":{"description":"Where it stands now: not begun, standing, or how it ended.","type":"string","x-extensible-enum":["scheduled","active","expired","ended","revoked","refunded"]},"revocable":{"description":"Whether `revokeGrant` may still end it.","type":"boolean"},"granted_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"recorded_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["token_id","customer","product","tier","id","customer_id","product_id","tier_id","source_kind","source_ref","grant_reason","settlement_id","valid_from","ends_at","end_reason","status","revocable","granted_by","occurred_at","recorded_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customer":{"description":"By id, or by email: whoever the address reaches, else its invited customer.","anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"email":{"type":"string","minLength":1,"maxLength":254,"pattern":"^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$"}},"required":["email"],"additionalProperties":false}]},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"null"}]},"ends_at":{"anyOf":[{"type":"string","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})(?:T(\\d{2}):(\\d{2})(?::(\\d{2})(?:\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string","minLength":1,"maxLength":500},{"type":"null"}]}},"required":["customer","product","tier"],"additionalProperties":false}}}}}},"/v1/stores/{store}/grants/{grant}/revoke":{"post":{"operationId":"revokeGrant","summary":"Revokes a grant of access.","tags":["customer"],"security":[{"bearer":["customer:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"grant","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Revokes a grant of access.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},{"type":"null"}]},"id":{"type":"string"},"customer_id":{"type":"string"},"product_id":{"type":"string"},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"source_kind":{"type":"string","x-extensible-enum":["checkout","api","manual","subscription","payment","automation"]},"source_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"grant_reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"settlement_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"valid_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"end_reason":{"anyOf":[{"type":"string","x-extensible-enum":["manual","lapse","refund"]},{"type":"null"}]},"status":{"description":"Where it stands now: not begun, standing, or how it ended.","type":"string","x-extensible-enum":["scheduled","active","expired","ended","revoked","refunded"]},"revocable":{"description":"Whether `revokeGrant` may still end it.","type":"boolean"},"granted_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"recorded_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["token_id","customer","product","tier","id","customer_id","product_id","tier_id","source_kind","source_ref","grant_reason","settlement_id","valid_from","ends_at","end_reason","status","revocable","granted_by","occurred_at","recorded_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","minLength":1,"maxLength":500}},"required":["reason"],"additionalProperties":false}}}}}},"/v1/stores/{store}/revocations":{"post":{"operationId":"createRevocation","summary":"Revokes a customer's access to a purchase's products, or a grant's, for cause: their access ends at once, their subscriptions to them stop, the customer is mailed with an optional message, and an optional refund is sent through Stripe or recorded.","tags":["transaction"],"security":[{"bearer":["transaction:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"201":{"description":"Revokes a customer's access to a purchase's products, or a grant's, for cause: their access ends at once, their subscriptions to them stop, the customer is mailed with an optional message, and an optional refund is sent through Stripe or recorded.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"customer_id":{"type":"string"},"order_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"grant_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"product_ids":{"type":"array","items":{"type":"string"}},"cause":{"type":"string","x-extensible-enum":["other","terms_violation","fraud","chargeback","abuse"]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"message":{"anyOf":[{"type":"string"},{"type":"null"}]},"refund":{"anyOf":[{"type":"object","properties":{"via":{"type":"string","x-extensible-enum":["stripe","recorded"]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"settlement_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"refund_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","x-extensible-enum":["pending","failed","refunded","taken_back"]},{"type":"null"}]}},"required":["via","amount","currency","exponent","settlement_id","refund_id","status"]},{"type":"null"}]},"revoked_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","customer_id","order_id","grant_id","product_ids","cause","note","message","refund","revoked_by","token_id","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text_format":{"type":"string","enum":["html","markdown"],"default":"html","description":"The format the rich text fields are written in: the rich text format’s HTML, or Markdown converted into it before it is validated. A text already stored in the format (starting with `<rich-text`) is kept as it is either way."},"order":{"description":"The purchase whose products the customer loses; give this or `grant`.","type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"grant":{"description":"The grant whose product the customer loses; give this or `order`.","type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"cause":{"type":"string","enum":["other","terms_violation","fraud","chargeback","abuse"]},"note":{"description":"Staff's own words, never shown to the customer.","anyOf":[{"type":"string","minLength":1,"maxLength":500},{"type":"null"}]},"message":{"description":"The seller's words to the customer, added to the mail that always tells them: a rich text with no blocks, stored in its canonical form in 16 KiB of UTF-8; empty sends none.","anyOf":[{"type":"string","maxLength":16384},{"type":"null"}],"x-rich-text":"text"},"refund":{"description":"Money given back with it; without one, none moves.","anyOf":[{"type":"object","properties":{"amount":{"type":"integer","minimum":1},"via":{"description":"Sent through Stripe, or recorded as given back elsewhere.","type":"string","enum":["stripe","recorded"]},"settlement":{"description":"The payment it comes off; the order's only one, or the grant's, when left out.","type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"processor_ref":{"description":"The processor's own id of a refund made elsewhere.","anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},"required":["amount","via"],"additionalProperties":false},{"type":"null"}]}},"required":["cause"],"additionalProperties":false}}}}},"get":{"operationId":"listRevocations","summary":"Pages the revocations of customers' access for cause, of one customer or one order when named, with each one's refund.","tags":["transaction"],"security":[{"bearer":["transaction:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"customer","in":"query","description":"An id.","schema":{"type":"string","minLength":1,"description":"An id."}},{"name":"order","in":"query","description":"An id.","schema":{"type":"string","minLength":1,"description":"An id."}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["created"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"facets","in":"query","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["cause"]}}}],"responses":{"200":{"description":"Pages the revocations of customers' access for cause, of one customer or one order when named, with each one's refund.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"customer_id":{"type":"string"},"order_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"grant_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"product_ids":{"type":"array","items":{"type":"string"}},"cause":{"type":"string","x-extensible-enum":["other","terms_violation","fraud","chargeback","abuse"]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"message":{"anyOf":[{"type":"string"},{"type":"null"}]},"refund":{"anyOf":[{"type":"object","properties":{"via":{"type":"string","x-extensible-enum":["stripe","recorded"]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"settlement_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"refund_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","x-extensible-enum":["pending","failed","refunded","taken_back"]},{"type":"null"}]}},"required":["via","amount","currency","exponent","settlement_id","refund_id","status"]},{"type":"null"}]},"revoked_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","customer_id","order_id","grant_id","product_ids","cause","note","message","refund","revoked_by","token_id","created_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/revocations/{revocation}/refund/retry":{"post":{"operationId":"retryRevocationRefund","summary":"Sends a revocation's failed Stripe refund again.","tags":["transaction"],"security":[{"bearer":["transaction:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"revocation","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Sends a revocation's failed Stripe refund again.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"customer_id":{"type":"string"},"order_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"grant_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"product_ids":{"type":"array","items":{"type":"string"}},"cause":{"type":"string","x-extensible-enum":["other","terms_violation","fraud","chargeback","abuse"]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"message":{"anyOf":[{"type":"string"},{"type":"null"}]},"refund":{"anyOf":[{"type":"object","properties":{"via":{"type":"string","x-extensible-enum":["stripe","recorded"]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"settlement_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"refund_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","x-extensible-enum":["pending","failed","refunded","taken_back"]},{"type":"null"}]}},"required":["via","amount","currency","exponent","settlement_id","refund_id","status"]},{"type":"null"}]},"revoked_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","customer_id","order_id","grant_id","product_ids","cause","note","message","refund","revoked_by","token_id","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}}}},"/v1/stores/{store}/feeds":{"get":{"operationId":"listFeeds","summary":"Pages customers' private feeds of blogs, podcasts and events, with the readers each served lately and its limit.","tags":["customer"],"security":[{"bearer":["customer:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"customer","in":"query","description":"An id.","schema":{"type":"string","minLength":1,"description":"An id."}},{"name":"product","in":"query","description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1,"description":"An id, or `slug:<slug>`."}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["created"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Pages customers' private feeds of blogs, podcasts and events, with the readers each served lately and its limit.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"id":{"type":"string"},"customer_id":{"type":"string"},"product_id":{"type":"string"},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"readers":{"description":"Readers it served in the last 30 days, each shared fetcher for the people it reports.","type":"number"},"reader_limit":{"description":"Readers it serves in 30 days before it moves to a new URL.","type":"number"},"reader_limit_set":{"description":"Whether the limit is the merchant's own rather than the default.","type":"boolean"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revoked_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revoked_reason":{"description":"Why it stopped: a new URL replaced it, too many readers shared it, its customer or the merchant revoked it, or the product turned private feeds off.","anyOf":[{"type":"string","x-extensible-enum":["revoked","disabled","merchant","rotated","shared"]},{"type":"null"}]}},"required":["customer","id","customer_id","product_id","product","readers","reader_limit","reader_limit_set","created_at","revoked_at","revoked_reason"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/feeds":{"get":{"operationId":"listProductFeeds","summary":"Pages customers' private feeds of blogs, podcasts and events, with the readers each served lately and its limit.","tags":["customer"],"security":[{"bearer":["customer:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"customer","in":"query","description":"An id.","schema":{"type":"string","minLength":1,"description":"An id."}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["created"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Pages customers' private feeds of blogs, podcasts and events, with the readers each served lately and its limit.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"id":{"type":"string"},"customer_id":{"type":"string"},"product_id":{"type":"string"},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"readers":{"description":"Readers it served in the last 30 days, each shared fetcher for the people it reports.","type":"number"},"reader_limit":{"description":"Readers it serves in 30 days before it moves to a new URL.","type":"number"},"reader_limit_set":{"description":"Whether the limit is the merchant's own rather than the default.","type":"boolean"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revoked_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revoked_reason":{"description":"Why it stopped: a new URL replaced it, too many readers shared it, its customer or the merchant revoked it, or the product turned private feeds off.","anyOf":[{"type":"string","x-extensible-enum":["revoked","disabled","merchant","rotated","shared"]},{"type":"null"}]}},"required":["customer","id","customer_id","product_id","product","readers","reader_limit","reader_limit_set","created_at","revoked_at","revoked_reason"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/feeds/{feed}":{"patch":{"operationId":"updateFeed","summary":"Sets how many readers a customer's private feed serves in 30 days before it moves to a new URL.","tags":["customer"],"security":[{"bearer":["customer:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"feed","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Sets how many readers a customer's private feed serves in 30 days before it moves to a new URL.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"customer_id":{"type":"string"},"product_id":{"type":"string"},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"readers":{"description":"Readers it served in the last 30 days, each shared fetcher for the people it reports.","type":"number"},"reader_limit":{"description":"Readers it serves in 30 days before it moves to a new URL.","type":"number"},"reader_limit_set":{"description":"Whether the limit is the merchant's own rather than the default.","type":"boolean"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revoked_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revoked_reason":{"description":"Why it stopped: a new URL replaced it, too many readers shared it, its customer or the merchant revoked it, or the product turned private feeds off.","anyOf":[{"type":"string","x-extensible-enum":["revoked","disabled","merchant","rotated","shared"]},{"type":"null"}]}},"required":["id","customer_id","product_id","product","readers","reader_limit","reader_limit_set","created_at","revoked_at","revoked_reason"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reader_limit":{"description":"Readers it serves in 30 days before it moves to a new URL; null holds the default of 5.","anyOf":[{"type":"integer","minimum":1,"maximum":50},{"type":"null"}]}},"required":["reader_limit"],"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/feeds/{feed}/revoke":{"post":{"operationId":"revokeFeed","summary":"Stops a customer's private feed of a blog, a podcast or an event.","tags":["customer"],"security":[{"bearer":["customer:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"feed","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Stops a customer's private feed of a blog, a podcast or an event.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"customer_id":{"type":"string"},"product_id":{"type":"string"},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"readers":{"description":"Readers it served in the last 30 days, each shared fetcher for the people it reports.","type":"number"},"reader_limit":{"description":"Readers it serves in 30 days before it moves to a new URL.","type":"number"},"reader_limit_set":{"description":"Whether the limit is the merchant's own rather than the default.","type":"boolean"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revoked_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revoked_reason":{"description":"Why it stopped: a new URL replaced it, too many readers shared it, its customer or the merchant revoked it, or the product turned private feeds off.","anyOf":[{"type":"string","x-extensible-enum":["revoked","disabled","merchant","rotated","shared"]},{"type":"null"}]}},"required":["id","customer_id","product_id","product","readers","reader_limit","reader_limit_set","created_at","revoked_at","revoked_reason"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/feeds/unblock":{"post":{"operationId":"unblockFeed","summary":"Lets a customer hold a private feed of a blog, a podcast or an event again after repeated sharing turned it off, counting sharing afresh.","tags":["customer"],"security":[{"bearer":["customer:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Lets a customer hold a private feed of a blog, a podcast or an event again after repeated sharing turned it off, counting sharing afresh.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"string"},"product_id":{"type":"string"},"blocked":{"type":"boolean"}},"required":["customer_id","product_id","blocked"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customer":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"required":["customer"],"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/licenses":{"get":{"operationId":"listLicenses","summary":"Pages a software product's licenses, their keys shortened to their last characters.","tags":["customer"],"security":[{"bearer":["customer:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","description":"Sorted by last_verified, rows without a value come last either way.","schema":{"type":"string","enum":["created","last_verified","uses"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"search","in":"query","schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"facets","in":"query","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["status","source"]}}}],"responses":{"200":{"description":"Pages a software product's licenses, their keys shortened to their last characters.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"activations":{"description":"The devices it counts now and the most it may hold, its own limit, else its tier's, else its product's; `limit` null when nothing limits it.","type":"object","properties":{"count":{"type":"number"},"limit":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["count","limit"]},"key_ending":{"description":"The key's last characters, so a support reply can name it; `getLicense` answers it whole.","type":"string"},"tier":{"description":"The tier its access opens, else the one it last opened; null for access with no tier.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"id":{"type":"string"},"product_id":{"type":"string"},"customer_id":{"type":"string"},"source":{"type":"string","x-extensible-enum":["issued","imported"]},"status":{"description":"Where it stands now: `active`, `expired`, `revoked`, `disabled` or `replaced`.","type":"string","x-extensible-enum":["active","expired","revoked","disabled","replaced"]},"expires_at":{"description":"When access ends; null while it never does.","anyOf":[{"type":"string"},{"type":"null"}]},"reason":{"description":"Why it reads its status: `replaced`, `disabled`, `lapse`, `refund` or `revoke`; null while active, or before any access began.","anyOf":[{"type":"string","x-extensible-enum":["lapse","refund","disabled","replaced","revoke"]},{"type":"null"}]},"has_access":{"description":"Whether its holder has access now, whatever its status; false before access begins.","type":"boolean"},"activation_limit":{"anyOf":[{"type":"number"},{"type":"null"}]},"uses":{"type":"number"},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"disabled_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"disabled_reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"replaced_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_verified_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["activations","key_ending","tier","customer","id","product_id","customer_id","source","status","expires_at","reason","has_access","activation_limit","uses","metadata","created_at","disabled_at","disabled_reason","replaced_by","last_verified_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"post":{"operationId":"recordLicense","summary":"Records a key a customer holds from another platform as their license to a software product, so software in the field keeps checking; it may land disabled, or take the place of the customer's license.","tags":["customer"],"security":[{"bearer":["customer:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"201":{"description":"Records a key a customer holds from another platform as their license to a software product, so software in the field keeps checking; it may land disabled, or take the place of the customer's license.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"subscription":{"description":"The subscription behind its access; null for a one-time purchase or a grant, or without `subscription:read`.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","x-extensible-enum":["unpaid","active","past_due","paused","cancelled","ended"]},"current_period_end":{"description":"When its latest paid period ends; null when none is paid.","anyOf":[{"type":"string"},{"type":"null"}]},"cancel_at_period_end":{"type":"boolean"},"ended_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","status","current_period_end","cancel_at_period_end","ended_at"]},{"type":"null"}]},"activations":{"description":"The devices it counts now and the most it may hold, its own limit, else its tier's, else its product's; `limit` null when nothing limits it.","type":"object","properties":{"count":{"type":"number"},"limit":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["count","limit"]},"key_ending":{"description":"The key's last characters, so a support reply can name it; `getLicense` answers it whole.","type":"string"},"tier":{"description":"The tier its access opens, else the one it last opened; null for access with no tier.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"id":{"type":"string"},"product_id":{"type":"string"},"customer_id":{"type":"string"},"source":{"type":"string","x-extensible-enum":["issued","imported"]},"status":{"description":"Where it stands now: `active`, `expired`, `revoked`, `disabled` or `replaced`.","type":"string","x-extensible-enum":["active","expired","revoked","disabled","replaced"]},"expires_at":{"description":"When access ends; null while it never does.","anyOf":[{"type":"string"},{"type":"null"}]},"reason":{"description":"Why it reads its status: `replaced`, `disabled`, `lapse`, `refund` or `revoke`; null while active, or before any access began.","anyOf":[{"type":"string","x-extensible-enum":["lapse","refund","disabled","replaced","revoke"]},{"type":"null"}]},"has_access":{"description":"Whether its holder has access now, whatever its status; false before access begins.","type":"boolean"},"activation_limit":{"anyOf":[{"type":"number"},{"type":"null"}]},"uses":{"type":"number"},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"disabled_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"disabled_reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"replaced_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_verified_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["subscription","activations","key_ending","tier","customer","id","product_id","customer_id","source","status","expires_at","reason","has_access","activation_limit","uses","metadata","created_at","disabled_at","disabled_reason","replaced_by","last_verified_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customer":{"description":"By id, or by email: whoever the address reaches, else a new invited customer.","anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"email":{"type":"string","minLength":1,"maxLength":254,"pattern":"^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$"}},"required":["email"],"additionalProperties":false}]},"key":{"description":"The key as the old platform issued it, kept verbatim; a hex key matches in any case and spacing, any other exactly.","type":"string","minLength":6,"maxLength":128,"pattern":"^[A-Za-z0-9._-]*[A-Za-z0-9][A-Za-z0-9._-]*$"},"uses":{"description":"How many times software checked it so far; a replace keeps the replaced license's by default.","type":"integer","minimum":0,"maximum":1000000000},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"disabled":{"description":"Record it disabled, as for a key refunded or turned off at the old platform; defaults to false, or to the replaced license's state.","type":"boolean"},"disabled_reason":{"description":"Why it is disabled; only with `disabled`.","anyOf":[{"type":"string","minLength":1,"maxLength":500},{"type":"null"}]},"replace":{"description":"Take the place of the customer's live license for the product, keeping its limit, which then reads as replaced. Defaults to false.","type":"boolean"}},"required":["customer","key"],"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/licenses/{license}":{"get":{"operationId":"getLicense","summary":"Gets a license with its key, its status and the subscription behind it.","tags":["customer"],"security":[{"bearer":["customer:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"license","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Gets a license with its key, its status and the subscription behind it.","content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string"},"subscription":{"description":"The subscription behind its access; null for a one-time purchase or a grant, or without `subscription:read`.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","x-extensible-enum":["unpaid","active","past_due","paused","cancelled","ended"]},"current_period_end":{"description":"When its latest paid period ends; null when none is paid.","anyOf":[{"type":"string"},{"type":"null"}]},"cancel_at_period_end":{"type":"boolean"},"ended_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","status","current_period_end","cancel_at_period_end","ended_at"]},{"type":"null"}]},"activations":{"description":"The devices it counts now and the most it may hold, its own limit, else its tier's, else its product's; `limit` null when nothing limits it.","type":"object","properties":{"count":{"type":"number"},"limit":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["count","limit"]},"key_ending":{"description":"The key's last characters, so a support reply can name it; `getLicense` answers it whole.","type":"string"},"tier":{"description":"The tier its access opens, else the one it last opened; null for access with no tier.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"id":{"type":"string"},"product_id":{"type":"string"},"customer_id":{"type":"string"},"source":{"type":"string","x-extensible-enum":["issued","imported"]},"status":{"description":"Where it stands now: `active`, `expired`, `revoked`, `disabled` or `replaced`.","type":"string","x-extensible-enum":["active","expired","revoked","disabled","replaced"]},"expires_at":{"description":"When access ends; null while it never does.","anyOf":[{"type":"string"},{"type":"null"}]},"reason":{"description":"Why it reads its status: `replaced`, `disabled`, `lapse`, `refund` or `revoke`; null while active, or before any access began.","anyOf":[{"type":"string","x-extensible-enum":["lapse","refund","disabled","replaced","revoke"]},{"type":"null"}]},"has_access":{"description":"Whether its holder has access now, whatever its status; false before access begins.","type":"boolean"},"activation_limit":{"anyOf":[{"type":"number"},{"type":"null"}]},"uses":{"type":"number"},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"disabled_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"disabled_reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"replaced_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_verified_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["key","subscription","activations","key_ending","tier","customer","id","product_id","customer_id","source","status","expires_at","reason","has_access","activation_limit","uses","metadata","created_at","disabled_at","disabled_reason","replaced_by","last_verified_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"patch":{"operationId":"updateLicense","summary":"Sets a license's activation limit, its uses or its metadata.","tags":["customer"],"security":[{"bearer":["customer:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"license","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Sets a license's activation limit, its uses or its metadata.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"subscription":{"description":"The subscription behind its access; null for a one-time purchase or a grant, or without `subscription:read`.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","x-extensible-enum":["unpaid","active","past_due","paused","cancelled","ended"]},"current_period_end":{"description":"When its latest paid period ends; null when none is paid.","anyOf":[{"type":"string"},{"type":"null"}]},"cancel_at_period_end":{"type":"boolean"},"ended_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","status","current_period_end","cancel_at_period_end","ended_at"]},{"type":"null"}]},"activations":{"description":"The devices it counts now and the most it may hold, its own limit, else its tier's, else its product's; `limit` null when nothing limits it.","type":"object","properties":{"count":{"type":"number"},"limit":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["count","limit"]},"key_ending":{"description":"The key's last characters, so a support reply can name it; `getLicense` answers it whole.","type":"string"},"tier":{"description":"The tier its access opens, else the one it last opened; null for access with no tier.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"id":{"type":"string"},"product_id":{"type":"string"},"customer_id":{"type":"string"},"source":{"type":"string","x-extensible-enum":["issued","imported"]},"status":{"description":"Where it stands now: `active`, `expired`, `revoked`, `disabled` or `replaced`.","type":"string","x-extensible-enum":["active","expired","revoked","disabled","replaced"]},"expires_at":{"description":"When access ends; null while it never does.","anyOf":[{"type":"string"},{"type":"null"}]},"reason":{"description":"Why it reads its status: `replaced`, `disabled`, `lapse`, `refund` or `revoke`; null while active, or before any access began.","anyOf":[{"type":"string","x-extensible-enum":["lapse","refund","disabled","replaced","revoke"]},{"type":"null"}]},"has_access":{"description":"Whether its holder has access now, whatever its status; false before access begins.","type":"boolean"},"activation_limit":{"anyOf":[{"type":"number"},{"type":"null"}]},"uses":{"type":"number"},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"disabled_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"disabled_reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"replaced_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_verified_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["subscription","activations","key_ending","tier","customer","id","product_id","customer_id","source","status","expires_at","reason","has_access","activation_limit","uses","metadata","created_at","disabled_at","disabled_reason","replaced_by","last_verified_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"activation_limit":{"description":"How many activations it may hold; null holds its tier's, else its product's.","anyOf":[{"type":"integer","minimum":1,"maximum":10000},{"type":"null"}]},"uses":{"description":"How many times software checked it, set as a whole; lower it to give uses back.","type":"integer","minimum":0,"maximum":1000000000},"metadata":{"description":"Replaces the stored metadata whole.","type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/licenses/{license}/disable":{"post":{"operationId":"disableLicense","summary":"Stops a license from checking as valid, whatever its holder's access.","tags":["customer"],"security":[{"bearer":["customer:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"license","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Stops a license from checking as valid, whatever its holder's access.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"subscription":{"description":"The subscription behind its access; null for a one-time purchase or a grant, or without `subscription:read`.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","x-extensible-enum":["unpaid","active","past_due","paused","cancelled","ended"]},"current_period_end":{"description":"When its latest paid period ends; null when none is paid.","anyOf":[{"type":"string"},{"type":"null"}]},"cancel_at_period_end":{"type":"boolean"},"ended_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","status","current_period_end","cancel_at_period_end","ended_at"]},{"type":"null"}]},"activations":{"description":"The devices it counts now and the most it may hold, its own limit, else its tier's, else its product's; `limit` null when nothing limits it.","type":"object","properties":{"count":{"type":"number"},"limit":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["count","limit"]},"key_ending":{"description":"The key's last characters, so a support reply can name it; `getLicense` answers it whole.","type":"string"},"tier":{"description":"The tier its access opens, else the one it last opened; null for access with no tier.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"id":{"type":"string"},"product_id":{"type":"string"},"customer_id":{"type":"string"},"source":{"type":"string","x-extensible-enum":["issued","imported"]},"status":{"description":"Where it stands now: `active`, `expired`, `revoked`, `disabled` or `replaced`.","type":"string","x-extensible-enum":["active","expired","revoked","disabled","replaced"]},"expires_at":{"description":"When access ends; null while it never does.","anyOf":[{"type":"string"},{"type":"null"}]},"reason":{"description":"Why it reads its status: `replaced`, `disabled`, `lapse`, `refund` or `revoke`; null while active, or before any access began.","anyOf":[{"type":"string","x-extensible-enum":["lapse","refund","disabled","replaced","revoke"]},{"type":"null"}]},"has_access":{"description":"Whether its holder has access now, whatever its status; false before access begins.","type":"boolean"},"activation_limit":{"anyOf":[{"type":"number"},{"type":"null"}]},"uses":{"type":"number"},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"disabled_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"disabled_reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"replaced_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_verified_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["subscription","activations","key_ending","tier","customer","id","product_id","customer_id","source","status","expires_at","reason","has_access","activation_limit","uses","metadata","created_at","disabled_at","disabled_reason","replaced_by","last_verified_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"description":"Why, kept with the license and told in its event.","anyOf":[{"type":"string","minLength":1,"maxLength":500},{"type":"null"}]}},"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/licenses/{license}/enable":{"post":{"operationId":"enableLicense","summary":"Lets a disabled license check as its holder's access says again.","tags":["customer"],"security":[{"bearer":["customer:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"license","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Lets a disabled license check as its holder's access says again.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"subscription":{"description":"The subscription behind its access; null for a one-time purchase or a grant, or without `subscription:read`.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","x-extensible-enum":["unpaid","active","past_due","paused","cancelled","ended"]},"current_period_end":{"description":"When its latest paid period ends; null when none is paid.","anyOf":[{"type":"string"},{"type":"null"}]},"cancel_at_period_end":{"type":"boolean"},"ended_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","status","current_period_end","cancel_at_period_end","ended_at"]},{"type":"null"}]},"activations":{"description":"The devices it counts now and the most it may hold, its own limit, else its tier's, else its product's; `limit` null when nothing limits it.","type":"object","properties":{"count":{"type":"number"},"limit":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["count","limit"]},"key_ending":{"description":"The key's last characters, so a support reply can name it; `getLicense` answers it whole.","type":"string"},"tier":{"description":"The tier its access opens, else the one it last opened; null for access with no tier.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"id":{"type":"string"},"product_id":{"type":"string"},"customer_id":{"type":"string"},"source":{"type":"string","x-extensible-enum":["issued","imported"]},"status":{"description":"Where it stands now: `active`, `expired`, `revoked`, `disabled` or `replaced`.","type":"string","x-extensible-enum":["active","expired","revoked","disabled","replaced"]},"expires_at":{"description":"When access ends; null while it never does.","anyOf":[{"type":"string"},{"type":"null"}]},"reason":{"description":"Why it reads its status: `replaced`, `disabled`, `lapse`, `refund` or `revoke`; null while active, or before any access began.","anyOf":[{"type":"string","x-extensible-enum":["lapse","refund","disabled","replaced","revoke"]},{"type":"null"}]},"has_access":{"description":"Whether its holder has access now, whatever its status; false before access begins.","type":"boolean"},"activation_limit":{"anyOf":[{"type":"number"},{"type":"null"}]},"uses":{"type":"number"},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"disabled_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"disabled_reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"replaced_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_verified_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["subscription","activations","key_ending","tier","customer","id","product_id","customer_id","source","status","expires_at","reason","has_access","activation_limit","uses","metadata","created_at","disabled_at","disabled_reason","replaced_by","last_verified_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/licenses/stats":{"get":{"operationId":"licenseStats","summary":"Reads a software product's license activity over a period: licenses issued and imported, verifies and uses, active licenses a day, and devices activated, freed and refused at the limit.","tags":["customer"],"security":[{"bearer":["customer:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"from","in":"query","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","schema":{"type":"string","format":"date"}},{"name":"bucket","in":"query","schema":{"type":"string","enum":["day","week","month"]}}],"responses":{"200":{"description":"Reads a software product's license activity over a period: licenses issued and imported, verifies and uses, active licenses a day, and devices activated, freed and refused at the limit.","content":{"application/json":{"schema":{"type":"object","properties":{"issued":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"imported":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"verifies":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"uses":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"active_license_days":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"activations":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"deactivations":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"refusals":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"series":{"type":"array","items":{"type":"object","properties":{"previous_verifies":{"type":"number"},"previous_active_license_days":{"type":"number"},"previous_activations":{"type":"number"},"issued":{"description":"Licenses the store minted.","type":"number"},"imported":{"description":"Licenses recorded from another platform.","type":"number"},"verifies":{"description":"Checks from the seller's server.","type":"number"},"uses":{"description":"Checks that counted a use.","type":"number"},"active_license_days":{"description":"Each license that checked in while active, once a day, summed over the days.","type":"number"},"activations":{"description":"Devices that began counting, new or come back.","type":"number"},"deactivations":{"description":"Devices freed by their holder, the merchant, the software, or a new key.","type":"number"},"refusals":{"description":"Activations refused at the limit.","type":"number"},"start":{"type":"string"},"end":{"type":"string"}},"required":["previous_verifies","previous_active_license_days","previous_activations","issued","imported","verifies","uses","active_license_days","activations","deactivations","refusals","start","end"]}},"bucket":{"type":"string","x-extensible-enum":["day","week","month"]},"time_zone":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"previous_range":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"]}},"required":["issued","imported","verifies","uses","active_license_days","activations","deactivations","refusals","series","bucket","time_zone","from","to","previous_range"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/licenses/{license}/activations":{"get":{"operationId":"listLicenseActivations","summary":"Pages the devices a license counts, latest activated first, with those freed or gone inactive, never their instance ids.","tags":["customer"],"security":[{"bearer":["customer:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"license","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["activated","last_seen"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Pages the devices a license counts, latest activated first, with those freed or gone inactive, never their instance ids.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"license_id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"description":"`active` counts toward the limit; `inactive` went unseen past the product's inactive days; `deactivated` was freed.","type":"string","x-extensible-enum":["active","inactive","deactivated"]},"created_at":{"type":"string"},"activated_at":{"type":"string"},"last_seen_at":{"type":"string"},"deactivated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"deactivated_by":{"description":"Who freed it: `customer`, `merchant` or `software`; null while not freed.","anyOf":[{"type":"string","x-extensible-enum":["customer","merchant","software"]},{"type":"null"}]}},"required":["id","license_id","name","status","created_at","activated_at","last_seen_at","deactivated_at","deactivated_by"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/licenses/{license}/activations/{activation}/deactivate":{"post":{"operationId":"deactivateLicenseActivation","summary":"Frees one of a license's devices, so it stops counting toward the activation limit, whatever the license's status.","tags":["customer"],"security":[{"bearer":["customer:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"license","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"activation","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Frees one of a license's devices, so it stops counting toward the activation limit, whatever the license's status.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"activation":{"type":"object","properties":{"id":{"type":"string"},"license_id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"description":"`active` counts toward the limit; `inactive` went unseen past the product's inactive days; `deactivated` was freed.","type":"string","x-extensible-enum":["active","inactive","deactivated"]},"created_at":{"type":"string"},"activated_at":{"type":"string"},"last_seen_at":{"type":"string"},"deactivated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"deactivated_by":{"description":"Who freed it: `customer`, `merchant` or `software`; null while not freed.","anyOf":[{"type":"string","x-extensible-enum":["customer","merchant","software"]},{"type":"null"}]}},"required":["id","license_id","name","status","created_at","activated_at","last_seen_at","deactivated_at","deactivated_by"]},"activations":{"type":"object","properties":{"count":{"type":"number"},"limit":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["count","limit"]}},"required":["activation","activations"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/licenses/{license}/rotate":{"post":{"operationId":"rotateLicense","summary":"Gives a license a fresh key and emails it to the holder; the old key stops checking at once.","tags":["customer"],"security":[{"bearer":["customer:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"license","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Gives a license a fresh key and emails it to the holder; the old key stops checking at once.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string"},"subscription":{"description":"The subscription behind its access; null for a one-time purchase or a grant, or without `subscription:read`.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","x-extensible-enum":["unpaid","active","past_due","paused","cancelled","ended"]},"current_period_end":{"description":"When its latest paid period ends; null when none is paid.","anyOf":[{"type":"string"},{"type":"null"}]},"cancel_at_period_end":{"type":"boolean"},"ended_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","status","current_period_end","cancel_at_period_end","ended_at"]},{"type":"null"}]},"activations":{"description":"The devices it counts now and the most it may hold, its own limit, else its tier's, else its product's; `limit` null when nothing limits it.","type":"object","properties":{"count":{"type":"number"},"limit":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["count","limit"]},"key_ending":{"description":"The key's last characters, so a support reply can name it; `getLicense` answers it whole.","type":"string"},"tier":{"description":"The tier its access opens, else the one it last opened; null for access with no tier.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"id":{"type":"string"},"product_id":{"type":"string"},"customer_id":{"type":"string"},"source":{"type":"string","x-extensible-enum":["issued","imported"]},"status":{"description":"Where it stands now: `active`, `expired`, `revoked`, `disabled` or `replaced`.","type":"string","x-extensible-enum":["active","expired","revoked","disabled","replaced"]},"expires_at":{"description":"When access ends; null while it never does.","anyOf":[{"type":"string"},{"type":"null"}]},"reason":{"description":"Why it reads its status: `replaced`, `disabled`, `lapse`, `refund` or `revoke`; null while active, or before any access began.","anyOf":[{"type":"string","x-extensible-enum":["lapse","refund","disabled","replaced","revoke"]},{"type":"null"}]},"has_access":{"description":"Whether its holder has access now, whatever its status; false before access begins.","type":"boolean"},"activation_limit":{"anyOf":[{"type":"number"},{"type":"null"}]},"uses":{"type":"number"},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"disabled_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"disabled_reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"replaced_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_verified_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["key","subscription","activations","key_ending","tier","customer","id","product_id","customer_id","source","status","expires_at","reason","has_access","activation_limit","uses","metadata","created_at","disabled_at","disabled_reason","replaced_by","last_verified_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/licenses/verify":{"post":{"operationId":"verifyLicense","summary":"Checks a software product's license key from the seller's server: its status, why it is not active, when it ends, its tier and features, its uses, its devices and the subscription behind it; with `count_use` an active one counts a use, and with `instance` it reads and stamps that device. An unknown key, or another product's, answers `not_found`.","tags":["customer"],"security":[{"bearer":["customer:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Checks a software product's license key from the seller's server: its status, why it is not active, when it ends, its tier and features, its uses, its devices and the subscription behind it; with `count_use` an active one counts a use, and with `instance` it reads and stamps that device. An unknown key, or another product's, answers `not_found`.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"status":{"description":"Where it stands now: `active`, `expired`, `revoked`, `disabled` or `replaced`.","type":"string","x-extensible-enum":["active","expired","revoked","disabled","replaced"]},"reason":{"description":"Why it is not active: `replaced`, `disabled`, `lapse`, `refund` or `revoke`; null while active, or before any access began.","anyOf":[{"type":"string","x-extensible-enum":["lapse","refund","disabled","replaced","revoke"]},{"type":"null"}]},"expires_at":{"description":"When all of the holder's access ends, whatever its tier; null while it never does.","anyOf":[{"type":"string"},{"type":"null"}]},"tier":{"description":"The tier its access opens, else the one it last opened; null for access with no tier.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]},"features":{"description":"What that tier unlocks with every tier below it, as their settings list them; none unless active.","type":"array","items":{"type":"string"}},"uses":{"description":"How many checks counted it as a use, this one included.","type":"number"},"activations":{"description":"The devices it counts now and the most it may hold; `limit` null when nothing limits it.","type":"object","properties":{"count":{"type":"number"},"limit":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["count","limit"]},"activation":{"description":"The device `instance` names, its last seen stamped while it counts and the license is active; null without `instance`, or when it holds none.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"license_id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"description":"`active` counts toward the limit; `inactive` went unseen past the product's inactive days; `deactivated` was freed.","type":"string","x-extensible-enum":["active","inactive","deactivated"]},"created_at":{"type":"string"},"activated_at":{"type":"string"},"last_seen_at":{"type":"string"},"deactivated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"deactivated_by":{"description":"Who freed it: `customer`, `merchant` or `software`; null while not freed.","anyOf":[{"type":"string","x-extensible-enum":["customer","merchant","software"]},{"type":"null"}]}},"required":["id","license_id","name","status","created_at","activated_at","last_seen_at","deactivated_at","deactivated_by"]},{"type":"null"}]},"customer":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"subscription":{"description":"The subscription behind that access; null for a one-time purchase or a grant.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","x-extensible-enum":["unpaid","active","past_due","paused","cancelled","ended"]},"current_period_end":{"description":"When its latest paid period ends; null when none is paid.","anyOf":[{"type":"string"},{"type":"null"}]},"cancel_at_period_end":{"type":"boolean"},"ended_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","status","current_period_end","cancel_at_period_end","ended_at"]},{"type":"null"}]},"latest_release":{"description":"The product's newest release whose files are all in, whatever tier opens them, so the software can tell an update is out; null before its first.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","version","occurred_at"]},{"type":"null"}]}},"required":["id","status","reason","expires_at","tier","features","uses","activations","activation","customer","subscription","latest_release"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"description":"The key as the customer typed it: case, hyphens, spaces and Crockford's look-alikes don't matter, except for an imported key that is not hex, which matches exactly.","type":"string","minLength":1,"maxLength":128},"count_use":{"description":"Count this check as a use of the software; only an active license counts. Defaults to false.","type":"boolean"},"instance":{"description":"The device the software runs on, as it activated it, to read and stamp that activation.","type":"string","minLength":1,"maxLength":256}},"required":["key"],"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/licenses/activate":{"post":{"operationId":"activateLicense","summary":"Counts a device toward a software product's license from the seller's server, or refreshes one it already counts, and answers a signed token the software checks offline; past the license's activation limit (10,000 when nothing limits it) it answers `conflict` on `items`, and a license that is not active `conflict` on `status`.","tags":["customer"],"security":[{"bearer":["customer:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Counts a device toward a software product's license from the seller's server, or refreshes one it already counts, and answers a signed token the software checks offline; past the license's activation limit (10,000 when nothing limits it) it answers `conflict` on `items`, and a license that is not active `conflict` on `status`.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"activations":{"type":"object","properties":{"count":{"type":"number"},"limit":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["count","limit"]},"activation":{"type":"object","properties":{"id":{"type":"string"},"license_id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"description":"`active` counts toward the limit; `inactive` went unseen past the product's inactive days; `deactivated` was freed.","type":"string","x-extensible-enum":["active","inactive","deactivated"]},"created_at":{"type":"string"},"activated_at":{"type":"string"},"last_seen_at":{"type":"string"},"deactivated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"deactivated_by":{"description":"Who freed it: `customer`, `merchant` or `software`; null while not freed.","anyOf":[{"type":"string","x-extensible-enum":["customer","merchant","software"]},{"type":"null"}]}},"required":["id","license_id","name","status","created_at","activated_at","last_seen_at","deactivated_at","deactivated_by"]},"token":{"description":"A compact JWS (EdDSA) the software checks offline against the store's published signing keys.","type":"string"},"token_expires_at":{"description":"When the token stops verifying: the earliest of the product's offline window and the end of the access it carries.","type":"string"}},"required":["activations","activation","token","token_expires_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"description":"The key as the customer typed it.","type":"string","minLength":1,"maxLength":128},"instance":{"description":"A stable id of the device or seat, chosen by the software; only its keyed digest is kept.","type":"string","minLength":1,"maxLength":256},"name":{"description":"What the holder and the merchant see it as, such as the device's name.","type":"string","minLength":1,"maxLength":480}},"required":["key","instance"],"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/licenses/token":{"post":{"operationId":"refreshLicenseToken","summary":"Answers a fresh signed token for a device a software product's active license counts, from the seller's server, stamping the device seen; a license that is not active answers `conflict` on `status`, and a device it does not count (never activated, freed or gone inactive) `not_found`.","tags":["customer"],"security":[{"bearer":["customer:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Answers a fresh signed token for a device a software product's active license counts, from the seller's server, stamping the device seen; a license that is not active answers `conflict` on `status`, and a device it does not count (never activated, freed or gone inactive) `not_found`.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"activations":{"type":"object","properties":{"count":{"type":"number"},"limit":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["count","limit"]},"activation":{"type":"object","properties":{"id":{"type":"string"},"license_id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"description":"`active` counts toward the limit; `inactive` went unseen past the product's inactive days; `deactivated` was freed.","type":"string","x-extensible-enum":["active","inactive","deactivated"]},"created_at":{"type":"string"},"activated_at":{"type":"string"},"last_seen_at":{"type":"string"},"deactivated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"deactivated_by":{"description":"Who freed it: `customer`, `merchant` or `software`; null while not freed.","anyOf":[{"type":"string","x-extensible-enum":["customer","merchant","software"]},{"type":"null"}]}},"required":["id","license_id","name","status","created_at","activated_at","last_seen_at","deactivated_at","deactivated_by"]},"token":{"description":"A compact JWS (EdDSA) the software checks offline against the store's published signing keys.","type":"string"},"token_expires_at":{"description":"When the token stops verifying: the earliest of the product's offline window and the end of the access it carries.","type":"string"}},"required":["activations","activation","token","token_expires_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"description":"The key as the customer typed it.","type":"string","minLength":1,"maxLength":128},"instance":{"description":"The device's id, as it was activated.","type":"string","minLength":1,"maxLength":256}},"required":["key","instance"],"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/licenses/deactivate":{"post":{"operationId":"deactivateLicense","summary":"Frees a device of a software product's license from the seller's server, whatever the license's status, an inactive one too; a device never activated, or already freed, answers `not_found`.","tags":["customer"],"security":[{"bearer":["customer:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Frees a device of a software product's license from the seller's server, whatever the license's status, an inactive one too; a device never activated, or already freed, answers `not_found`.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"activation":{"type":"object","properties":{"id":{"type":"string"},"license_id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"description":"`active` counts toward the limit; `inactive` went unseen past the product's inactive days; `deactivated` was freed.","type":"string","x-extensible-enum":["active","inactive","deactivated"]},"created_at":{"type":"string"},"activated_at":{"type":"string"},"last_seen_at":{"type":"string"},"deactivated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"deactivated_by":{"description":"Who freed it: `customer`, `merchant` or `software`; null while not freed.","anyOf":[{"type":"string","x-extensible-enum":["customer","merchant","software"]},{"type":"null"}]}},"required":["id","license_id","name","status","created_at","activated_at","last_seen_at","deactivated_at","deactivated_by"]},"activations":{"type":"object","properties":{"count":{"type":"number"},"limit":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["count","limit"]}},"required":["activation","activations"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"description":"The key as the customer typed it.","type":"string","minLength":1,"maxLength":128},"instance":{"description":"The device's id, as it was activated.","type":"string","minLength":1,"maxLength":256}},"required":["key","instance"],"additionalProperties":false}}}}}},"/v1/stores/{store}/license_signing_keys":{"get":{"operationId":"listLicenseSigningKeys","summary":"Lists the store's published Ed25519 keys as JSON Web Keys, which software checks offline license tokens against: the one that signs, the next one, and those rotated out while a token they signed may live.","tags":["customer"],"security":[{"bearer":["customer:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Lists the store's published Ed25519 keys as JSON Web Keys, which software checks offline license tokens against: the one that signs, the next one, and those rotated out while a token they signed may live.","content":{"application/json":{"schema":{"type":"object","properties":{"keys":{"type":"array","items":{"type":"object","properties":{"kid":{"type":"string"},"kty":{"type":"string","x-extensible-enum":["OKP"]},"crv":{"type":"string","x-extensible-enum":["Ed25519"]},"x":{"description":"The raw 32-byte public key, base64url, as a JWK's `x`.","type":"string"},"alg":{"type":"string","x-extensible-enum":["EdDSA"]},"use":{"type":"string","x-extensible-enum":["sig"]},"status":{"description":"`current` signs new tokens; `next` signs once the keys rotate; `previous` signs nothing more and stays published while a token it signed may live.","type":"string","x-extensible-enum":["current","previous","next"]},"created_at":{"type":"string"},"expires_at":{"description":"When it leaves the set, as the longest offline window after it stopped signing; null while it signs or waits to.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["kid","kty","crv","x","alg","use","status","created_at","expires_at"]}}},"required":["keys"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/license_signing_keys/rotate":{"post":{"operationId":"rotateLicenseSigningKeys","summary":"Promotes the store's next license signing key to sign new tokens and publishes a fresh next one, keeping the old key published for 365 days; with `retire_previous` every key that no longer signs leaves the published set at once, though software that embeds it trusts it until updated. With `current`, a rotation since answers `conflict`. A store with no keys gets its first set.","tags":["customer"],"security":[{"bearer":["customer:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Promotes the store's next license signing key to sign new tokens and publishes a fresh next one, keeping the old key published for 365 days; with `retire_previous` every key that no longer signs leaves the published set at once, though software that embeds it trusts it until updated. With `current`, a rotation since answers `conflict`. A store with no keys gets its first set.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"keys":{"type":"array","items":{"type":"object","properties":{"kid":{"type":"string"},"kty":{"type":"string","x-extensible-enum":["OKP"]},"crv":{"type":"string","x-extensible-enum":["Ed25519"]},"x":{"description":"The raw 32-byte public key, base64url, as a JWK's `x`.","type":"string"},"alg":{"type":"string","x-extensible-enum":["EdDSA"]},"use":{"type":"string","x-extensible-enum":["sig"]},"status":{"description":"`current` signs new tokens; `next` signs once the keys rotate; `previous` signs nothing more and stays published while a token it signed may live.","type":"string","x-extensible-enum":["current","previous","next"]},"created_at":{"type":"string"},"expires_at":{"description":"When it leaves the set, as the longest offline window after it stopped signing; null while it signs or waits to.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["kid","kty","crv","x","alg","use","status","created_at","expires_at"]}}},"required":["keys"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"current":{"description":"The key that signs now, as you last read it, or null for a store with none; a rotation since answers `conflict` on `revision`, so a retry never rotates twice.","anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"null"}]},"retire_previous":{"description":"Drop every key that no longer signs from the published set at once, as after a leak; sets fetched from then on leave them out. Defaults to false.","type":"boolean"}},"additionalProperties":false}}}}}},"/v1/stores/{store}/entitlements":{"get":{"operationId":"listEntitlements","summary":"Pages what customers may reach, as their grants and subscriptions add up.","tags":["customer"],"security":[{"bearer":["customer:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"customer","in":"query","description":"An id.","schema":{"type":"string","minLength":1,"description":"An id."}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["rebuilt"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Pages what customers may reach, as their grants and subscriptions add up.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"customer_id":{"type":"string"},"product_id":{"type":"string"},"tier_rank":{"type":"number"},"expires_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier_expires_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"next_change_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"rebuilt_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["customer","product","customer_id","product_id","tier_rank","expires_at","tier_expires_at","next_change_at","rebuilt_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/customers":{"get":{"operationId":"listCustomers","summary":"Pages the store's customers.","tags":["customer"],"security":[{"bearer":["customer:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","description":"Sorted by name, rows without a value come last either way.","schema":{"type":"string","enum":["created","name"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"search","in":"query","schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"facets","in":"query","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["erased"]}}}],"responses":{"200":{"description":"Pages the store's customers.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"contacts":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["email","phone"]},"value":{"type":"string"},"verified_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["kind","value","verified_at"]}},"totals":{"type":"object","properties":{"orders":{"type":"number"},"spent":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"gross":{"anyOf":[{"type":"number"},{"type":"null"}]},"refunded":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["currency","exponent","amount","gross","refunded"]}},"active_subscriptions":{"type":"number"}},"required":["orders","spent","active_subscriptions"]},"id":{"type":"string"},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"locale":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"invited_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["contacts","totals","id","display_name","locale","country","erased_at","invited_at","created_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/customer_activity":{"get":{"operationId":"listCustomerActivity","summary":"Pages customers' activity over a period.","tags":["customer"],"security":[{"bearer":["customer:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"from","in":"query","schema":{"type":"string","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},{"name":"to","in":"query","schema":{"type":"string","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","description":"Sorted by name, rows without a value come last either way.","schema":{"type":"string","enum":["gross","orders","recent","name"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Pages customers' activity over a period.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"orders":{"type":"number"},"gross":{"anyOf":[{"type":"number"},{"type":"null"}]},"average":{"anyOf":[{"type":"number"},{"type":"null"}]},"first_order_at":{"type":"string"},"last_order_at":{"type":"string"}},"required":["id","customer","country","currency","exponent","orders","gross","average","first_order_at","last_order_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}},"time_zone":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"}},"required":["items","cursor","time_zone","from","to"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/customers":{"get":{"operationId":"listProductCustomers","summary":"Pages a product's customers.","tags":["customer"],"security":[{"bearer":["customer:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","description":"Sorted by name, rows without a value come last either way.","schema":{"type":"string","enum":["started","date","name"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"search","in":"query","schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"facets","in":"query","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["status"]}}}],"responses":{"200":{"description":"Pages a product's customers.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"started_at":{"type":"string"},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"progress":{"type":"object","properties":{"completed":{"type":"number"},"total":{"type":"number"}},"required":["completed","total"]},"answers":{"description":"Their answers to the product's registration questions, in the questions' order.","type":"array","items":{"type":"object","properties":{"question_id":{"type":"string"},"value":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["question_id","value"]}},"actions":{"description":"A subscription's moves, as `getSubscription` answers them; null for a grant.","anyOf":[{"type":"object","properties":{"cancel":{"type":"object","properties":{"period_end":{"description":"Stopping at the period's end: it bills, is not set to stop, and its period has not ended or is not known yet.","type":"boolean"},"now":{"description":"Ending it now, revoking what it paid for.","type":"boolean"}},"required":["period_end","now"]},"resume":{"description":"Taking a stop back: it still bills and is set to stop.","type":"boolean"}},"required":["cancel","resume"]},{"type":"null"}]},"next_event":{"description":"A subscription's next event, as `getSubscription` answers it; null for a grant.","anyOf":[{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["renews","ends","lapses"]},"at":{"type":"string"}},"required":["kind","at"]},{"type":"null"}]},"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["subscription","grant"]},"source_kind":{"anyOf":[{"type":"string"},{"type":"null"}]},"customer_id":{"type":"string"},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"price_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"order_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"cancel_reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["scheduled","unpaid","active","expired","past_due","paused","cancelled","ended","revoked","cancelling","refunded"]}},"required":["started_at","ends_at","progress","answers","actions","next_event","id","kind","source_kind","customer_id","customer","price_id","order_id","cancel_reason","status"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/customers/stats":{"get":{"operationId":"productCustomerStats","summary":"Counts a product's customers by status.","tags":["customer"],"security":[{"bearer":["customer:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Counts a product's customers by status.","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"number"},"by_status":{"type":"object","properties":{"scheduled":{"type":"number"},"unpaid":{"type":"number"},"active":{"type":"number"},"expired":{"type":"number"},"past_due":{"type":"number"},"paused":{"type":"number"},"cancelled":{"type":"number"},"ended":{"type":"number"},"revoked":{"type":"number"},"cancelling":{"type":"number"},"refunded":{"type":"number"}},"required":["scheduled","unpaid","active","expired","past_due","paused","cancelled","ended","revoked","cancelling","refunded"]},"by_kind":{"type":"object","properties":{"subscription":{"type":"number"},"grant":{"type":"number"}},"required":["subscription","grant"]},"active_granted":{"type":"number"},"active_subscribed":{"type":"number"}},"required":["total","by_status","by_kind","active_granted","active_subscribed"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/checkouts":{"get":{"operationId":"listCheckouts","summary":"Pages the store's checkouts.","tags":["customer"],"security":[{"bearer":["customer:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"customer","in":"query","description":"An id.","schema":{"type":"string","minLength":1,"description":"An id."}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["created"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"facets","in":"query","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["status"]}}}],"responses":{"200":{"description":"Pages the store's checkouts.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["paid","expired","open","frozen","abandoned"]},"items":{"type":"array","items":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"refund_policy":{"anyOf":[{"type":"string","x-extensible-enum":["none","24h","72h","7d","14d","30d"]},{"type":"null"}]},"refund_until":{"anyOf":[{"type":"string"},{"type":"null"}]},"id":{"type":"string"},"product_id":{"type":"string"},"price_id":{"type":"string"},"quantity":{"type":"number"},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"discount":{"anyOf":[{"type":"number"},{"type":"null"}]},"discount_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"anyOf":[{"type":"number"},{"type":"null"}]},"mode":{"type":"string","x-extensible-enum":["upgrade","purchase","renewal"]},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"message":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["product","refund_policy","refund_until","id","product_id","price_id","quantity","amount","discount","discount_id","total","mode","display_name","message"]}},"totals":{"type":"object","properties":{"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"discount":{"anyOf":[{"type":"number"},{"type":"null"}]},"total":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["amount","discount","total"]},"id":{"type":"string"},"customer_id":{"type":"string"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"discount_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"coupon":{"anyOf":[{"type":"string"},{"type":"null"}]},"refund_waiver":{"anyOf":[{"type":"object","properties":{"policy":{"description":"The strictest policy among the lines, the one consented to.","type":"string"},"accepted_at":{"type":"string"}},"required":["policy","accepted_at"]},{"type":"null"}]},"under_minimum":{"anyOf":[{"type":"object","properties":{"processor":{"type":"string","const":"stripe"},"minimum":{"description":"Null when the processor refused the payment as too small rather than core reading its minimum.","anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["processor","minimum","amount"]},{"type":"null"}]},"refunds_refused":{"description":"Payments on the cart whose refund Stripe refused for good, oldest first: the store's to hand back, less what is still `pending`.","type":"array","items":{"type":"object","properties":{"processor_ref":{"type":"string"},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"pending":{"anyOf":[{"type":"number"},{"type":"null"}]},"refused_at":{"type":"string"}},"required":["processor_ref","amount","pending","refused_at"]}},"expires_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["customer","status","items","totals","id","customer_id","currency","exponent","discount_id","coupon","refund_waiver","under_minimum","refunds_refused","expires_at","created_at","updated_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/customers/{customer}":{"get":{"operationId":"getCustomer","summary":"Reads one customer.","tags":["customer"],"security":[{"bearer":["customer:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"customer","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Reads one customer.","content":{"application/json":{"schema":{"type":"object","properties":{"orders":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"number"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"discount":{"anyOf":[{"type":"number"},{"type":"null"}]},"total":{"anyOf":[{"type":"number"},{"type":"null"}]},"free":{"type":"boolean"},"fees":{"anyOf":[{"type":"number"},{"type":"null"}]},"source":{"type":"string","x-extensible-enum":["checkout","api","manual"]},"source_key":{"anyOf":[{"type":"string"},{"type":"null"}]},"statements":{"type":"object","properties":{"coupon":{"type":"string"},"customer_status":{"description":"How well the buyer was known; `fake` is a seeded order.","type":"string","x-extensible-enum":["anon","verified","fake"]},"method":{"description":"The payment method the processor reported.","type":"string"},"method_details":{"description":"What the method shows, as a saved instrument's display: its brand and last 4 digits.","type":"object","properties":{"brand":{"anyOf":[{"type":"string"},{"type":"null"}]},"last4":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["brand","last4"]},"refund_waiver":{"description":"Carried from the checkout.","type":"object","properties":{"policy":{"description":"The strictest policy among the lines, the one consented to.","type":"string"},"accepted_at":{"type":"string"}},"required":["policy","accepted_at"]},"under_minimum":{"type":"object","properties":{"processor":{"type":"string","const":"stripe"},"minimum":{"description":"Null when the processor refused the payment as too small rather than core reading its minimum.","anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["processor","minimum","amount"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"recorded_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","number","customer_id","currency","exponent","amount","discount","total","free","fees","source","source_key","statements","note","occurred_at","recorded_at"]}},"total":{"type":"number"}},"required":["items","total"]},"subscriptions":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"display_status":{"description":"Its status as people read it: `cancelling` while it bills and is set to stop.","type":"string","x-extensible-enum":["unpaid","active","past_due","paused","cancelled","ended","cancelling"]},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"id":{"type":"string"},"customer_id":{"type":"string"},"product_id":{"type":"string"},"plan_id":{"type":"string"},"processor":{"anyOf":[{"type":"string","x-extensible-enum":["stripe"]},{"type":"null"}]},"external_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"account_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["unpaid","active","past_due","paused","cancelled","ended"]},"cancel_at_period_end":{"type":"boolean"},"instrument_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"cancel_reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"ended_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["display_status","product","id","customer_id","product_id","plan_id","processor","external_ref","account_ref","status","cancel_at_period_end","instrument_ref","cancel_reason","created_at","ended_at"]}},"total":{"type":"number"}},"required":["items","total"]},"grants":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"id":{"type":"string"},"customer_id":{"type":"string"},"product_id":{"type":"string"},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"source_kind":{"type":"string","x-extensible-enum":["checkout","api","manual","subscription","payment","automation"]},"source_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"grant_reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"settlement_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"valid_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"end_reason":{"anyOf":[{"type":"string","x-extensible-enum":["manual","lapse","refund"]},{"type":"null"}]},"status":{"description":"Where it stands now: not begun, standing, or how it ended.","type":"string","x-extensible-enum":["scheduled","active","expired","ended","revoked","refunded"]},"revocable":{"description":"Whether `revokeGrant` may still end it.","type":"boolean"},"granted_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"recorded_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["token_id","product","id","customer_id","product_id","tier_id","source_kind","source_ref","grant_reason","settlement_id","valid_from","ends_at","end_reason","status","revocable","granted_by","occurred_at","recorded_at"]}},"total":{"type":"number"}},"required":["items","total"]},"entitlements":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"customer_id":{"type":"string"},"product_id":{"type":"string"},"tier_rank":{"type":"number"},"expires_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier_expires_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"next_change_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"rebuilt_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["customer_id","product_id","tier_rank","expires_at","tier_expires_at","next_change_at","rebuilt_at"]}},"total":{"type":"number"}},"required":["items","total"]},"reviews":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"id":{"type":"string"},"product_id":{"type":"string"},"customer_id":{"type":"string"},"order_item_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"rating":{"type":"number"},"username":{"anyOf":[{"type":"string"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"reply":{"anyOf":[{"type":"string"},{"type":"null"}]},"replied_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"hidden_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"description":"When the customer last edited it; null until they do.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["product","id","product_id","customer_id","order_item_id","rating","username","notes","reply","replied_at","hidden_at","created_at","updated_at"]}},"total":{"type":"number"}},"required":["items","total"]},"attempts":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"quiz_id":{"type":"string"},"customer_id":{"type":"string"},"attempt":{"type":"number"},"status":{"type":"string","x-extensible-enum":["failed","started","submitted","passed","forfeited"]},"answers":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"answer":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]},"correct":{"type":"boolean"},"weight":{"type":"number"},"dropped":{"description":"The answer was given but couldn't be kept, so a null `answer` is not a blank.","type":"boolean","const":true}},"required":["answer","correct","weight"],"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"score":{"anyOf":[{"type":"number"},{"type":"null"}]},"correct":{"anyOf":[{"type":"number"},{"type":"null"}]},"started_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"finished_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","product_id","quiz_id","customer_id","attempt","status","answers","score","correct","started_at","finished_at"]}},"total":{"type":"number"}},"required":["items","total"]},"certificates":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"certificate_id":{"type":"string"},"customer_id":{"type":"string"},"score":{"anyOf":[{"type":"number"},{"type":"null"}]},"attempt":{"anyOf":[{"type":"number"},{"type":"null"}]},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revoked_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","product_id","certificate_id","customer_id","score","attempt","issued_at","revoked_at"]}},"total":{"type":"number"}},"required":["items","total"]},"feeds":{"description":"Their private feeds, live and stopped, newest first; `listFeeds` pages the rest.","type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"customer_id":{"type":"string"},"product_id":{"type":"string"},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"readers":{"description":"Readers it served in the last 30 days, each shared fetcher for the people it reports.","type":"number"},"reader_limit":{"description":"Readers it serves in 30 days before it moves to a new URL.","type":"number"},"reader_limit_set":{"description":"Whether the limit is the merchant's own rather than the default.","type":"boolean"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revoked_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revoked_reason":{"description":"Why it stopped: a new URL replaced it, too many readers shared it, its customer or the merchant revoked it, or the product turned private feeds off.","anyOf":[{"type":"string","x-extensible-enum":["revoked","disabled","merchant","rotated","shared"]},{"type":"null"}]}},"required":["id","customer_id","product_id","product","readers","reader_limit","reader_limit_set","created_at","revoked_at","revoked_reason"]}},"total":{"type":"number"},"blocked":{"description":"The blogs, podcasts and events whose private feed sharing turned off for them, until the merchant turns it on again.","type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"blocked_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["product_id","product","blocked_at"]}}},"required":["items","total","blocked"]},"contacts":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["email","phone"]},"value":{"type":"string"},"verified_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["kind","value","verified_at"]}},"totals":{"type":"object","properties":{"orders":{"type":"number"},"spent":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"gross":{"anyOf":[{"type":"number"},{"type":"null"}]},"refunded":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["currency","exponent","amount","gross","refunded"]}},"active_subscriptions":{"type":"number"}},"required":["orders","spent","active_subscriptions"]},"id":{"type":"string"},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"locale":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"invited_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["orders","subscriptions","grants","entitlements","reviews","attempts","certificates","feeds","contacts","totals","id","display_name","locale","country","erased_at","invited_at","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/customers/{customer}/erase":{"post":{"operationId":"eraseCustomer","summary":"Erases a customer's personal data, keeping the records of what they bought.","tags":["customer"],"security":[{"bearer":["customer:delete"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"customer","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Erases a customer's personal data, keeping the records of what they bought.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"orders":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"number"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"discount":{"anyOf":[{"type":"number"},{"type":"null"}]},"total":{"anyOf":[{"type":"number"},{"type":"null"}]},"free":{"type":"boolean"},"fees":{"anyOf":[{"type":"number"},{"type":"null"}]},"source":{"type":"string","x-extensible-enum":["checkout","api","manual"]},"source_key":{"anyOf":[{"type":"string"},{"type":"null"}]},"statements":{"type":"object","properties":{"coupon":{"type":"string"},"customer_status":{"description":"How well the buyer was known; `fake` is a seeded order.","type":"string","x-extensible-enum":["anon","verified","fake"]},"method":{"description":"The payment method the processor reported.","type":"string"},"method_details":{"description":"What the method shows, as a saved instrument's display: its brand and last 4 digits.","type":"object","properties":{"brand":{"anyOf":[{"type":"string"},{"type":"null"}]},"last4":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["brand","last4"]},"refund_waiver":{"description":"Carried from the checkout.","type":"object","properties":{"policy":{"description":"The strictest policy among the lines, the one consented to.","type":"string"},"accepted_at":{"type":"string"}},"required":["policy","accepted_at"]},"under_minimum":{"type":"object","properties":{"processor":{"type":"string","const":"stripe"},"minimum":{"description":"Null when the processor refused the payment as too small rather than core reading its minimum.","anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["processor","minimum","amount"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"recorded_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","number","customer_id","currency","exponent","amount","discount","total","free","fees","source","source_key","statements","note","occurred_at","recorded_at"]}},"total":{"type":"number"}},"required":["items","total"]},"subscriptions":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"display_status":{"description":"Its status as people read it: `cancelling` while it bills and is set to stop.","type":"string","x-extensible-enum":["unpaid","active","past_due","paused","cancelled","ended","cancelling"]},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"id":{"type":"string"},"customer_id":{"type":"string"},"product_id":{"type":"string"},"plan_id":{"type":"string"},"processor":{"anyOf":[{"type":"string","x-extensible-enum":["stripe"]},{"type":"null"}]},"external_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"account_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["unpaid","active","past_due","paused","cancelled","ended"]},"cancel_at_period_end":{"type":"boolean"},"instrument_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"cancel_reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"ended_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["display_status","product","id","customer_id","product_id","plan_id","processor","external_ref","account_ref","status","cancel_at_period_end","instrument_ref","cancel_reason","created_at","ended_at"]}},"total":{"type":"number"}},"required":["items","total"]},"grants":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"id":{"type":"string"},"customer_id":{"type":"string"},"product_id":{"type":"string"},"tier_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"source_kind":{"type":"string","x-extensible-enum":["checkout","api","manual","subscription","payment","automation"]},"source_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"grant_reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"settlement_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"valid_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"end_reason":{"anyOf":[{"type":"string","x-extensible-enum":["manual","lapse","refund"]},{"type":"null"}]},"status":{"description":"Where it stands now: not begun, standing, or how it ended.","type":"string","x-extensible-enum":["scheduled","active","expired","ended","revoked","refunded"]},"revocable":{"description":"Whether `revokeGrant` may still end it.","type":"boolean"},"granted_by":{"anyOf":[{"type":"string"},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"recorded_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["token_id","product","id","customer_id","product_id","tier_id","source_kind","source_ref","grant_reason","settlement_id","valid_from","ends_at","end_reason","status","revocable","granted_by","occurred_at","recorded_at"]}},"total":{"type":"number"}},"required":["items","total"]},"entitlements":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"customer_id":{"type":"string"},"product_id":{"type":"string"},"tier_rank":{"type":"number"},"expires_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier_expires_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"next_change_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"rebuilt_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["customer_id","product_id","tier_rank","expires_at","tier_expires_at","next_change_at","rebuilt_at"]}},"total":{"type":"number"}},"required":["items","total"]},"reviews":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"id":{"type":"string"},"product_id":{"type":"string"},"customer_id":{"type":"string"},"order_item_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"rating":{"type":"number"},"username":{"anyOf":[{"type":"string"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"reply":{"anyOf":[{"type":"string"},{"type":"null"}]},"replied_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"hidden_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"description":"When the customer last edited it; null until they do.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["product","id","product_id","customer_id","order_item_id","rating","username","notes","reply","replied_at","hidden_at","created_at","updated_at"]}},"total":{"type":"number"}},"required":["items","total"]},"attempts":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"quiz_id":{"type":"string"},"customer_id":{"type":"string"},"attempt":{"type":"number"},"status":{"type":"string","x-extensible-enum":["failed","started","submitted","passed","forfeited"]},"answers":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"answer":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]},"correct":{"type":"boolean"},"weight":{"type":"number"},"dropped":{"description":"The answer was given but couldn't be kept, so a null `answer` is not a blank.","type":"boolean","const":true}},"required":["answer","correct","weight"],"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"score":{"anyOf":[{"type":"number"},{"type":"null"}]},"correct":{"anyOf":[{"type":"number"},{"type":"null"}]},"started_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"finished_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","product_id","quiz_id","customer_id","attempt","status","answers","score","correct","started_at","finished_at"]}},"total":{"type":"number"}},"required":["items","total"]},"certificates":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"certificate_id":{"type":"string"},"customer_id":{"type":"string"},"score":{"anyOf":[{"type":"number"},{"type":"null"}]},"attempt":{"anyOf":[{"type":"number"},{"type":"null"}]},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revoked_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","product_id","certificate_id","customer_id","score","attempt","issued_at","revoked_at"]}},"total":{"type":"number"}},"required":["items","total"]},"feeds":{"description":"Their private feeds, live and stopped, newest first; `listFeeds` pages the rest.","type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"customer_id":{"type":"string"},"product_id":{"type":"string"},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"readers":{"description":"Readers it served in the last 30 days, each shared fetcher for the people it reports.","type":"number"},"reader_limit":{"description":"Readers it serves in 30 days before it moves to a new URL.","type":"number"},"reader_limit_set":{"description":"Whether the limit is the merchant's own rather than the default.","type":"boolean"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revoked_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revoked_reason":{"description":"Why it stopped: a new URL replaced it, too many readers shared it, its customer or the merchant revoked it, or the product turned private feeds off.","anyOf":[{"type":"string","x-extensible-enum":["revoked","disabled","merchant","rotated","shared"]},{"type":"null"}]}},"required":["id","customer_id","product_id","product","readers","reader_limit","reader_limit_set","created_at","revoked_at","revoked_reason"]}},"total":{"type":"number"},"blocked":{"description":"The blogs, podcasts and events whose private feed sharing turned off for them, until the merchant turns it on again.","type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"blocked_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["product_id","product","blocked_at"]}}},"required":["items","total","blocked"]},"contacts":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["email","phone"]},"value":{"type":"string"},"verified_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["kind","value","verified_at"]}},"totals":{"type":"object","properties":{"orders":{"type":"number"},"spent":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"gross":{"anyOf":[{"type":"number"},{"type":"null"}]},"refunded":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["currency","exponent","amount","gross","refunded"]}},"active_subscriptions":{"type":"number"}},"required":["orders","spent","active_subscriptions"]},"id":{"type":"string"},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"locale":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"invited_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["orders","subscriptions","grants","entitlements","reviews","attempts","certificates","feeds","contacts","totals","id","display_name","locale","country","erased_at","invited_at","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}}}},"/v1/stores/{store}/reviews":{"get":{"operationId":"listReviews","summary":"Pages the store's product reviews.","tags":["review"],"security":[{"bearer":["review:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"query","description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1,"description":"An id, or `slug:<slug>`."}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["created","rating"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"search","in":"query","schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"facets","in":"query","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["hidden"]}}}],"responses":{"200":{"description":"Pages the store's product reviews.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"id":{"type":"string"},"product_id":{"type":"string"},"customer_id":{"type":"string"},"order_item_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"rating":{"type":"number"},"username":{"anyOf":[{"type":"string"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"reply":{"anyOf":[{"type":"string"},{"type":"null"}]},"replied_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"hidden_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"description":"When the customer last edited it; null until they do.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["product","customer","id","product_id","customer_id","order_item_id","rating","username","notes","reply","replied_at","hidden_at","created_at","updated_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/reviews":{"get":{"operationId":"listProductReviews","summary":"Pages the store's product reviews.","tags":["review"],"security":[{"bearer":["review:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["created","rating"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"search","in":"query","schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"facets","in":"query","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["hidden"]}}}],"responses":{"200":{"description":"Pages the store's product reviews.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"id":{"type":"string"},"product_id":{"type":"string"},"customer_id":{"type":"string"},"order_item_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"rating":{"type":"number"},"username":{"anyOf":[{"type":"string"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"reply":{"anyOf":[{"type":"string"},{"type":"null"}]},"replied_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"hidden_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"description":"When the customer last edited it; null until they do.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["product","customer","id","product_id","customer_id","order_item_id","rating","username","notes","reply","replied_at","hidden_at","created_at","updated_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/reviews/stats":{"get":{"operationId":"reviewStats","summary":"Reads review counts and ratings.","tags":["review"],"security":[{"bearer":["review:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"query","description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1,"description":"An id, or `slug:<slug>`."}}],"responses":{"200":{"description":"Reads review counts and ratings.","content":{"application/json":{"schema":{"type":"object","properties":{"products":{"type":"number"},"summary":{"anyOf":[{"type":"string"},{"type":"null"}]},"topics":{"type":"array","items":{"type":"object","properties":{"topic":{"type":"string","x-extensible-enum":["certificate","value_for_money","quality","support","ease_of_use","description_accuracy","content_depth","clarity","pacing","production_quality","exercises","up_to_date","performance","transparency","risk","update_frequency","communication","file_quality","formats","completeness","new_content","worth_renewing"]},"positive":{"type":"number"},"negative":{"type":"number"}},"required":["topic","positive","negative"]}},"hidden":{"type":"number"},"count":{"type":"number"},"average":{"anyOf":[{"type":"number"},{"type":"null"}]},"histogram":{"type":"object","properties":{"1":{"type":"number"},"2":{"type":"number"},"3":{"type":"number"},"4":{"type":"number"},"5":{"type":"number"}},"required":["1","2","3","4","5"]}},"required":["products","summary","topics","hidden","count","average","histogram"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/reviews/stats":{"get":{"operationId":"productReviewStats","summary":"Reads review counts and ratings.","tags":["review"],"security":[{"bearer":["review:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Reads review counts and ratings.","content":{"application/json":{"schema":{"type":"object","properties":{"products":{"type":"number"},"summary":{"anyOf":[{"type":"string"},{"type":"null"}]},"topics":{"type":"array","items":{"type":"object","properties":{"topic":{"type":"string","x-extensible-enum":["certificate","value_for_money","quality","support","ease_of_use","description_accuracy","content_depth","clarity","pacing","production_quality","exercises","up_to_date","performance","transparency","risk","update_frequency","communication","file_quality","formats","completeness","new_content","worth_renewing"]},"positive":{"type":"number"},"negative":{"type":"number"}},"required":["topic","positive","negative"]}},"hidden":{"type":"number"},"count":{"type":"number"},"average":{"anyOf":[{"type":"number"},{"type":"null"}]},"histogram":{"type":"object","properties":{"1":{"type":"number"},"2":{"type":"number"},"3":{"type":"number"},"4":{"type":"number"},"5":{"type":"number"}},"required":["1","2","3","4","5"]}},"required":["products","summary","topics","hidden","count","average","histogram"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/reviews/{review}/hide":{"post":{"operationId":"hideReview","summary":"Hides a review from the store.","tags":["review"],"security":[{"bearer":["review:moderate"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"review","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Hides a review from the store.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"id":{"type":"string"},"product_id":{"type":"string"},"customer_id":{"type":"string"},"order_item_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"rating":{"type":"number"},"username":{"anyOf":[{"type":"string"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"reply":{"anyOf":[{"type":"string"},{"type":"null"}]},"replied_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"hidden_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"description":"When the customer last edited it; null until they do.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["product","customer","id","product_id","customer_id","order_item_id","rating","username","notes","reply","replied_at","hidden_at","created_at","updated_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/reviews/{review}/unhide":{"post":{"operationId":"unhideReview","summary":"Shows a hidden review again.","tags":["review"],"security":[{"bearer":["review:moderate"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"review","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Shows a hidden review again.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"id":{"type":"string"},"product_id":{"type":"string"},"customer_id":{"type":"string"},"order_item_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"rating":{"type":"number"},"username":{"anyOf":[{"type":"string"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"reply":{"anyOf":[{"type":"string"},{"type":"null"}]},"replied_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"hidden_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"description":"When the customer last edited it; null until they do.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["product","customer","id","product_id","customer_id","order_item_id","rating","username","notes","reply","replied_at","hidden_at","created_at","updated_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/reviews/{review}/reply":{"post":{"operationId":"replyToReview","summary":"Sets or clears the store's reply to a review.","tags":["review"],"security":[{"bearer":["review:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"review","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Sets or clears the store's reply to a review.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"id":{"type":"string"},"product_id":{"type":"string"},"customer_id":{"type":"string"},"order_item_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"rating":{"type":"number"},"username":{"anyOf":[{"type":"string"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"reply":{"anyOf":[{"type":"string"},{"type":"null"}]},"replied_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"hidden_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"description":"When the customer last edited it; null until they do.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["product","customer","id","product_id","customer_id","order_item_id","rating","username","notes","reply","replied_at","hidden_at","created_at","updated_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reply":{"anyOf":[{"type":"string","minLength":1,"maxLength":4000},{"type":"null"}]}},"required":["reply"],"additionalProperties":false}}}}}},"/v1/stores/{store}/attempts":{"get":{"operationId":"listAttempts","summary":"Pages customers' quiz attempts.","tags":["quiz"],"security":[{"bearer":["quiz:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"customer","in":"query","description":"An id.","schema":{"type":"string","minLength":1,"description":"An id."}},{"name":"product","in":"query","description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1,"description":"An id, or `slug:<slug>`."}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["started"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"search","in":"query","schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"facets","in":"query","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["status"]}}}],"responses":{"200":{"description":"Pages customers' quiz attempts.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"quiz":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"}},"required":["id","title"]},{"type":"null"}]},"id":{"type":"string"},"product_id":{"type":"string"},"quiz_id":{"type":"string"},"customer_id":{"type":"string"},"attempt":{"type":"number"},"status":{"type":"string","x-extensible-enum":["failed","started","submitted","passed","forfeited"]},"answers":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"answer":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]},"correct":{"type":"boolean"},"weight":{"type":"number"},"dropped":{"description":"The answer was given but couldn't be kept, so a null `answer` is not a blank.","type":"boolean","const":true}},"required":["answer","correct","weight"],"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"score":{"anyOf":[{"type":"number"},{"type":"null"}]},"correct":{"anyOf":[{"type":"number"},{"type":"null"}]},"started_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"finished_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["customer","quiz","id","product_id","quiz_id","customer_id","attempt","status","answers","score","correct","started_at","finished_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/attempts":{"get":{"operationId":"listProductAttempts","summary":"Pages customers' quiz attempts.","tags":["quiz"],"security":[{"bearer":["quiz:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"customer","in":"query","description":"An id.","schema":{"type":"string","minLength":1,"description":"An id."}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["started"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"search","in":"query","schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"facets","in":"query","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["status"]}}}],"responses":{"200":{"description":"Pages customers' quiz attempts.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"quiz":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"}},"required":["id","title"]},{"type":"null"}]},"id":{"type":"string"},"product_id":{"type":"string"},"quiz_id":{"type":"string"},"customer_id":{"type":"string"},"attempt":{"type":"number"},"status":{"type":"string","x-extensible-enum":["failed","started","submitted","passed","forfeited"]},"answers":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"answer":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]},"correct":{"type":"boolean"},"weight":{"type":"number"},"dropped":{"description":"The answer was given but couldn't be kept, so a null `answer` is not a blank.","type":"boolean","const":true}},"required":["answer","correct","weight"],"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"score":{"anyOf":[{"type":"number"},{"type":"null"}]},"correct":{"anyOf":[{"type":"number"},{"type":"null"}]},"started_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"finished_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["customer","quiz","id","product_id","quiz_id","customer_id","attempt","status","answers","score","correct","started_at","finished_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/attempts/{attempt}":{"get":{"operationId":"getAttempt","summary":"Reads one quiz attempt with its answers.","tags":["quiz"],"security":[{"bearer":["quiz:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"attempt","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Reads one quiz attempt with its answers.","content":{"application/json":{"schema":{"type":"object","properties":{"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"quiz":{"type":"object","properties":{"body":{"type":"object","properties":{"attachment_id":{"type":"string"},"asset_id":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"blocks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"}},"required":["type","id"],"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}}},"required":["attachment_id","asset_id","title","blocks"]},"question_count":{"description":"How many of its blocks are questions a sitter answers.","type":"number"},"files":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["video","audio","image","pdf","file"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes, null when it has none or is withheld.","anyOf":[{"type":"number"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"description":"Seconds.","anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"url":{"description":"A public file's lasting URL, an image's naming its widths' version as `#v=` once they're made; null for a private one, or one whose bytes haven't landed.","anyOf":[{"type":"string"},{"type":"null"}]},"resized":{"description":"A public image's smaller copies, narrowest first, for a `srcset`; left out until they're made and its width measured, for one kept as uploaded, and for any other file.","type":"array","items":{"type":"object","properties":{"width":{"description":"Its width in pixels, at most the image's own.","type":"integer","minimum":1},"avif":{"description":"A lasting URL to it as AVIF.","type":"string"},"webp":{"description":"A lasting URL to it as WebP.","type":"string"}},"required":["width","avif","webp"]}},"attachment_id":{"description":"The binding a private file opens through; null when the reader can't open it.","anyOf":[{"type":"string"},{"type":"null"}]},"unlocks":{"description":"What unlocks a file its own rules keep from the reader, any one; null for any other file.","anyOf":[{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product_name":{"type":"string"},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]}},"required":["product_id","product_name","tier"]}},{"type":"null"}]},"video":{"description":"A video's subtitles and published AI outputs, where its read lists any and the reader may play it.","type":"object","properties":{"attachment_id":{"type":"string"},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["attachment_id","tracks","outputs"]},"audio":{"description":"An audio file's waveform, subtitles and published AI outputs, where the reader may play it.","type":"object","properties":{"waveform":{"description":"256 levels from 0 to 255, base64, from the file's start to its end; null until drawn, or when it can't be.","anyOf":[{"type":"string"},{"type":"null"}]},"attachment_id":{"description":"The binding its tracks and outputs open through, which a public file carries here alone; null with none.","anyOf":[{"type":"string"},{"type":"null"}]},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["waveform","attachment_id","tracks","outputs"]}},"required":["id","kind","mime","name","bytes","width","height","duration","pages","status","url","attachment_id","unlocks"]}},"sittings":{"type":"number"},"certificates":{"type":"array","items":{"type":"object","properties":{"logo":{"anyOf":[{"type":"object","properties":{"attachment_id":{"type":"string"},"asset_id":{"type":"string"}},"required":["attachment_id","asset_id"]},{"type":"null"}]},"id":{"type":"string"},"product_id":{"type":"string"},"quiz_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"headline_copy":{"type":"string"},"title_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"awarded_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"score_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"out_of_score_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"template":{"type":"string","x-extensible-enum":["classic","framed"]},"accent":{"anyOf":[{"type":"string","x-extensible-enum":["emerald","blue","teal","indigo","purple","pink","red","orange","yellow","gray"]},{"type":"null"}]},"requires_passing":{"description":"Earned by passing the quiz, not by merely finishing it.","type":"boolean"},"earned_on":{"description":"Set on a certificate no quiz awards: finishing every entry of a course, or a check-in at an event, earns it; losing its quiz never makes one.","type":"string","x-extensible-enum":["completion","attendance"]},"shows":{"type":"array","items":{"type":"string","x-extensible-enum":["date","score","qr_code"]}}},"required":["template","accent"]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["logo","id","product_id","quiz_id","headline_copy","title_copy","awarded_copy","reason_copy","score_copy","out_of_score_copy","settings","created_at"]}},"id":{"type":"string"},"entry_id":{"type":"string"},"product_id":{"type":"string"},"version":{"type":"number"},"settings":{"type":"object","properties":{"attempts_allowed":{"anyOf":[{"type":"number"},{"type":"null"}]},"pass_mark":{"anyOf":[{"type":"number"},{"type":"null"}]},"show_answers":{"type":"boolean"}},"required":["attempts_allowed","pass_mark","show_answers"]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["body","question_count","files","sittings","certificates","id","entry_id","product_id","version","settings","created_at","updated_at"]},"id":{"type":"string"},"product_id":{"type":"string"},"quiz_id":{"type":"string"},"customer_id":{"type":"string"},"attempt":{"type":"number"},"status":{"type":"string","x-extensible-enum":["failed","started","submitted","passed","forfeited"]},"answers":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"answer":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]},"correct":{"type":"boolean"},"weight":{"type":"number"},"dropped":{"description":"The answer was given but couldn't be kept, so a null `answer` is not a blank.","type":"boolean","const":true}},"required":["answer","correct","weight"],"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"score":{"anyOf":[{"type":"number"},{"type":"null"}]},"correct":{"anyOf":[{"type":"number"},{"type":"null"}]},"started_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"finished_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["customer","quiz","id","product_id","quiz_id","customer_id","attempt","status","answers","score","correct","started_at","finished_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"delete":{"operationId":"deleteAttempt","summary":"Deletes one quiz attempt.","tags":["quiz"],"security":[{"bearer":["quiz:delete"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"attempt","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Deletes one quiz attempt.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean","const":true}},"required":["id","deleted"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/certificates":{"get":{"operationId":"listCertificates","summary":"Pages a product's certificates.","tags":["certificate"],"security":[{"bearer":["certificate:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["created"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"search","in":"query","schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Pages a product's certificates.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"logo":{"anyOf":[{"type":"object","properties":{"attachment_id":{"type":"string"},"asset_id":{"type":"string"}},"required":["attachment_id","asset_id"]},{"type":"null"}]},"issued":{"type":"number"},"id":{"type":"string"},"product_id":{"type":"string"},"quiz_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"headline_copy":{"type":"string"},"title_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"awarded_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"score_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"out_of_score_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"template":{"type":"string","x-extensible-enum":["classic","framed"]},"accent":{"anyOf":[{"type":"string","x-extensible-enum":["emerald","blue","teal","indigo","purple","pink","red","orange","yellow","gray"]},{"type":"null"}]},"requires_passing":{"description":"Earned by passing the quiz, not by merely finishing it.","type":"boolean"},"earned_on":{"description":"Set on a certificate no quiz awards: finishing every entry of a course, or a check-in at an event, earns it; losing its quiz never makes one.","type":"string","x-extensible-enum":["completion","attendance"]},"shows":{"type":"array","items":{"type":"string","x-extensible-enum":["date","score","qr_code"]}}},"required":["template","accent"]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["logo","issued","id","product_id","quiz_id","headline_copy","title_copy","awarded_copy","reason_copy","score_copy","out_of_score_copy","settings","created_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"post":{"operationId":"createCertificate","summary":"Creates a certificate for a product.","tags":["certificate"],"security":[{"bearer":["certificate:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"201":{"description":"Creates a certificate for a product.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"logo":{"anyOf":[{"type":"object","properties":{"attachment_id":{"type":"string"},"asset_id":{"type":"string"}},"required":["attachment_id","asset_id"]},{"type":"null"}]},"issued":{"type":"number"},"id":{"type":"string"},"product_id":{"type":"string"},"quiz_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"headline_copy":{"type":"string"},"title_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"awarded_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"score_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"out_of_score_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"template":{"type":"string","x-extensible-enum":["classic","framed"]},"accent":{"anyOf":[{"type":"string","x-extensible-enum":["emerald","blue","teal","indigo","purple","pink","red","orange","yellow","gray"]},{"type":"null"}]},"requires_passing":{"description":"Earned by passing the quiz, not by merely finishing it.","type":"boolean"},"earned_on":{"description":"Set on a certificate no quiz awards: finishing every entry of a course, or a check-in at an event, earns it; losing its quiz never makes one.","type":"string","x-extensible-enum":["completion","attendance"]},"shows":{"type":"array","items":{"type":"string","x-extensible-enum":["date","score","qr_code"]}}},"required":["template","accent"]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["logo","issued","id","product_id","quiz_id","headline_copy","title_copy","awarded_copy","reason_copy","score_copy","out_of_score_copy","settings","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"quiz":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"null"}]},"headline_copy":{"type":"string","minLength":1,"maxLength":500},"title_copy":{"anyOf":[{"type":"string","minLength":1,"maxLength":500},{"type":"null"}]},"awarded_copy":{"anyOf":[{"type":"string","minLength":1,"maxLength":500},{"type":"null"}]},"reason_copy":{"anyOf":[{"type":"string","minLength":1,"maxLength":500},{"type":"null"}]},"score_copy":{"anyOf":[{"type":"string","minLength":1,"maxLength":500},{"type":"null"}]},"out_of_score_copy":{"anyOf":[{"type":"string","minLength":1,"maxLength":500},{"type":"null"}]},"settings":{"type":"object","properties":{"requires_passing":{"type":"boolean"},"earned_on":{"description":"`completion` on a course, `attendance` (a check-in) on an event.","anyOf":[{"type":"string","enum":["completion","attendance"]},{"type":"null"}]},"shows":{"type":"array","items":{"type":"string","enum":["date","score","qr_code"]},"maxItems":3},"template":{"type":"string","enum":["classic","framed"]},"accent":{"description":"Null clears it, so it prints in the store's color.","anyOf":[{"type":"string","enum":["emerald","blue","teal","indigo","purple","pink","red","orange","yellow","gray"]},{"type":"null"}]}},"additionalProperties":false}},"required":["headline_copy"],"additionalProperties":false}}}}}},"/v1/stores/{store}/certificates/issues":{"get":{"operationId":"listCertificateIssues","summary":"Pages the certificates issued to customers.","tags":["certificate"],"security":[{"bearer":["certificate:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"query","description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1,"description":"An id, or `slug:<slug>`."}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["issued"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"search","in":"query","schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"facets","in":"query","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["revoked"]}}}],"responses":{"200":{"description":"Pages the certificates issued to customers.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"certificate":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"headline":{"type":"string"}},"required":["id","title","headline"]},{"type":"null"}]},"id":{"type":"string"},"product_id":{"type":"string"},"certificate_id":{"type":"string"},"customer_id":{"type":"string"},"score":{"anyOf":[{"type":"number"},{"type":"null"}]},"attempt":{"anyOf":[{"type":"number"},{"type":"null"}]},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revoked_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["customer","certificate","id","product_id","certificate_id","customer_id","score","attempt","issued_at","revoked_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/certificates/issues":{"get":{"operationId":"listProductCertificateIssues","summary":"Pages the certificates issued to customers.","tags":["certificate"],"security":[{"bearer":["certificate:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["issued"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"search","in":"query","schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"facets","in":"query","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["revoked"]}}}],"responses":{"200":{"description":"Pages the certificates issued to customers.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"certificate":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"headline":{"type":"string"}},"required":["id","title","headline"]},{"type":"null"}]},"id":{"type":"string"},"product_id":{"type":"string"},"certificate_id":{"type":"string"},"customer_id":{"type":"string"},"score":{"anyOf":[{"type":"number"},{"type":"null"}]},"attempt":{"anyOf":[{"type":"number"},{"type":"null"}]},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revoked_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["customer","certificate","id","product_id","certificate_id","customer_id","score","attempt","issued_at","revoked_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/certificates/stats":{"get":{"operationId":"certificateStats","summary":"Reads a product's certificate issues over a period.","tags":["certificate"],"security":[{"bearer":["certificate:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"from","in":"query","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Reads a product's certificate issues over a period.","content":{"application/json":{"schema":{"type":"object","properties":{"certificates":{"type":"number"},"total":{"type":"number"},"by_status":{"type":"object","properties":{"live":{"type":"number"},"revoked":{"type":"number"}},"required":["live","revoked"]},"issued":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"time_zone":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"previous_range":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"]}},"required":["certificates","total","by_status","issued","time_zone","from","to","previous_range"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/asset_deliveries":{"get":{"operationId":"listAssetDeliveries","summary":"Pages the deliveries of files from the last year, newest first, with the file, who it went to and its state, in the store's time zone.","tags":["file"],"security":[{"bearer":["file:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["issued"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Pages the deliveries of files from the last year, newest first, with the file, who it went to and its state, in the store's time zone.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"asset":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"null"},"title":{"type":"null"},"ext":{"type":"null"},"type":{"type":"null"},"mime":{"type":"null"},"bytes":{"description":"The file's size in bytes, null when it has none.","type":"null"},"enforcement":{"type":"null"}},"required":["id","name","title","ext","type","mime","bytes","enforcement"]},{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes, null when it has none.","anyOf":[{"type":"number"},{"type":"null"}]},"enforcement":{"type":"string","x-extensible-enum":["public","external","signed"]},"type":{"type":"string","x-extensible-enum":["video","audio","image","document","other"]}},"required":["id","name","title","ext","mime","bytes","enforcement","type"]}]},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"member":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name"]},{"type":"null"}]},"id":{"type":"string"},"asset_id":{"type":"string"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"member_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"intent":{"type":"string","x-extensible-enum":["preview","download","stream"]},"channel":{"type":"string","x-extensible-enum":["api","web","mcp","feed","staff"]},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"expires_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revoked_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"max_uses":{"anyOf":[{"type":"number"},{"type":"null"}]},"used_count":{"type":"number"},"used_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"type":"string","x-extensible-enum":["expired","revoked","used","unused"]}},"required":["asset","customer","member","id","asset_id","customer_id","member_id","intent","channel","issued_at","expires_at","revoked_at","max_uses","used_count","used_at","state"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}},"time_zone":{"type":"string"}},"required":["items","cursor","time_zone"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/asset_uses":{"get":{"operationId":"listAssetUses","summary":"Pages where files are used.","tags":["file"],"security":[{"bearer":["file:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["bound"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Pages where files are used.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"attachment_id":{"type":"string"},"asset_id":{"type":"string"},"role":{"type":"string","x-extensible-enum":["body","staged","staged_file","prose","teaser","embed","deliverable","poster","logo","prompt","stylesheet"]},"delivery":{"type":"string","x-extensible-enum":["inline","download","stream"]},"target":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry","store","quiz","certificate","holding","page"]},"id":{"type":"string"}},"required":["kind","id"]},"from_body":{"type":"boolean"},"detachable":{"type":"boolean"},"release":{"description":"The software release shipping it, whether it is the current download, and the release holders download once it goes; null for a file no release ships.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"},"current":{"type":"boolean"},"after":{"description":"The release whose files holders download once this file is gone; null when none would ship any.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"}},"required":["id","version"]},{"type":"null"}]}},"required":["id","version","current","after"]},{"type":"null"}]}},"required":["attachment_id","asset_id","role","delivery","target","from_body","detachable","release"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/certificates/{certificate}/issue":{"post":{"operationId":"issueCertificate","summary":"Issues a certificate to a customer.","tags":["certificate"],"security":[{"bearer":["certificate:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"certificate","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Issues a certificate to a customer.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"certificate":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"headline":{"type":"string"}},"required":["id","title","headline"]},{"type":"null"}]},"id":{"type":"string"},"product_id":{"type":"string"},"certificate_id":{"type":"string"},"customer_id":{"type":"string"},"score":{"anyOf":[{"type":"number"},{"type":"null"}]},"attempt":{"anyOf":[{"type":"number"},{"type":"null"}]},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revoked_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["customer","certificate","id","product_id","certificate_id","customer_id","score","attempt","issued_at","revoked_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customer":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"required":["customer"],"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/entries/{entry}/quizzes":{"get":{"operationId":"listQuizzes","summary":"Pages an entry's quizzes.","tags":["quiz"],"security":[{"bearer":["quiz:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"entry","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["version","created"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Pages an entry's quizzes.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"sittings":{"type":"number"},"id":{"type":"string"},"entry_id":{"type":"string"},"product_id":{"type":"string"},"version":{"type":"number"},"settings":{"type":"object","properties":{"attempts_allowed":{"anyOf":[{"type":"number"},{"type":"null"}]},"pass_mark":{"anyOf":[{"type":"number"},{"type":"null"}]},"show_answers":{"type":"boolean"}},"required":["attempts_allowed","pass_mark","show_answers"]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["sittings","id","entry_id","product_id","version","settings","created_at","updated_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"post":{"operationId":"createQuiz","summary":"Creates a quiz on an entry.","tags":["quiz"],"security":[{"bearer":["quiz:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"entry","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"201":{"description":"Creates a quiz on an entry.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"attempts_allowed":{"anyOf":[{"type":"number"},{"type":"null"}]},"pass_mark":{"anyOf":[{"type":"number"},{"type":"null"}]},"show_answers":{"type":"boolean"}},"required":["attempts_allowed","pass_mark","show_answers"]},"product_id":{"type":"string"},"entry_id":{"type":"string"},"version":{"type":"number"},"certificates":{"type":"array","items":{"type":"object","properties":{"logo":{"anyOf":[{"type":"object","properties":{"attachment_id":{"type":"string"},"asset_id":{"type":"string"}},"required":["attachment_id","asset_id"]},{"type":"null"}]},"id":{"type":"string"},"product_id":{"type":"string"},"quiz_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"headline_copy":{"type":"string"},"title_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"awarded_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"score_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"out_of_score_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"template":{"type":"string","x-extensible-enum":["classic","framed"]},"accent":{"anyOf":[{"type":"string","x-extensible-enum":["emerald","blue","teal","indigo","purple","pink","red","orange","yellow","gray"]},{"type":"null"}]},"requires_passing":{"description":"Earned by passing the quiz, not by merely finishing it.","type":"boolean"},"earned_on":{"description":"Set on a certificate no quiz awards: finishing every entry of a course, or a check-in at an event, earns it; losing its quiz never makes one.","type":"string","x-extensible-enum":["completion","attendance"]},"shows":{"type":"array","items":{"type":"string","x-extensible-enum":["date","score","qr_code"]}}},"required":["template","accent"]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["logo","id","product_id","quiz_id","headline_copy","title_copy","awarded_copy","reason_copy","score_copy","out_of_score_copy","settings","created_at"]}},"question_count":{"description":"How many of its blocks are questions a sitter answers.","type":"number"},"sittings":{"type":"number"},"body":{"type":"object","properties":{"attachment_id":{"type":"string"},"asset_id":{"description":"The body asset a later update's `replaces` names.","type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"blocks":{"description":"The questions as written; answered only with `full`.","type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"}},"required":["type","id"],"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}}},"required":["attachment_id","asset_id","title"]},"files":{"description":"The files its static text names, as its save bound them; answered only with `full`.","type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["video","audio","image","pdf","file"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes, null when it has none or is withheld.","anyOf":[{"type":"number"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"description":"Seconds.","anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"url":{"description":"A public file's lasting URL, an image's naming its widths' version as `#v=` once they're made; null for a private one, or one whose bytes haven't landed.","anyOf":[{"type":"string"},{"type":"null"}]},"resized":{"description":"A public image's smaller copies, narrowest first, for a `srcset`; left out until they're made and its width measured, for one kept as uploaded, and for any other file.","type":"array","items":{"type":"object","properties":{"width":{"description":"Its width in pixels, at most the image's own.","type":"integer","minimum":1},"avif":{"description":"A lasting URL to it as AVIF.","type":"string"},"webp":{"description":"A lasting URL to it as WebP.","type":"string"}},"required":["width","avif","webp"]}},"attachment_id":{"description":"The binding a private file opens through; null when the reader can't open it.","anyOf":[{"type":"string"},{"type":"null"}]},"unlocks":{"description":"What unlocks a file its own rules keep from the reader, any one; null for any other file.","anyOf":[{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product_name":{"type":"string"},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]}},"required":["product_id","product_name","tier"]}},{"type":"null"}]},"video":{"description":"A video's subtitles and published AI outputs, where its read lists any and the reader may play it.","type":"object","properties":{"attachment_id":{"type":"string"},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["attachment_id","tracks","outputs"]},"audio":{"description":"An audio file's waveform, subtitles and published AI outputs, where the reader may play it.","type":"object","properties":{"waveform":{"description":"256 levels from 0 to 255, base64, from the file's start to its end; null until drawn, or when it can't be.","anyOf":[{"type":"string"},{"type":"null"}]},"attachment_id":{"description":"The binding its tracks and outputs open through, which a public file carries here alone; null with none.","anyOf":[{"type":"string"},{"type":"null"}]},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["waveform","attachment_id","tracks","outputs"]}},"required":["id","kind","mime","name","bytes","width","height","duration","pages","status","url","attachment_id","unlocks"]}},"created":{"description":"The attachments the write bound: the files its new static text names.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string","x-extensible-enum":["prose","teaser","embed"]},"asset":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["id","role","asset"]}}},"required":["id","created_at","updated_at","settings","product_id","entry_id","version","certificates","question_count","sittings","body","created"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text_format":{"type":"string","enum":["html","markdown"],"default":"html","description":"The format the rich text fields are written in: the rich text format’s HTML, or Markdown converted into it before it is validated. A text already stored in the format (starting with `<rich-text`) is kept as it is either way."},"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true},"after":{"description":"The newest version the caller started from, null for none; a newer one refuses the write.","anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"null"}]},"follows":{"description":"The questions that version held as the caller read them; others there refuse the write.","type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"blocks":{"description":"The blocks as the editor writes them; a key the schema does not know is refused.","type":"array","items":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","const":"multiple_choice"},"id":{"type":"string"},"question":{"type":"string"},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"}},"required":["id","text"],"additionalProperties":false},"minItems":2,"maxItems":100},"correctOptionId":{"type":"string"},"weight":{"type":"number"},"hint":{"type":"string"},"explanation":{"type":"string"}},"required":["type","id","question","options","correctOptionId","weight"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"scale"},"id":{"type":"string"},"question":{"type":"string"},"min":{"type":"number"},"max":{"type":"number"},"correctValue":{"type":"number"},"weight":{"type":"number"},"hint":{"type":"string"},"explanation":{"type":"string"}},"required":["type","id","question","min","max","correctValue","weight"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"static_text"},"id":{"type":"string"},"content":{"description":"The text a sitter reads, in the rich text format with the blocks a lesson takes, showing a reader at most 500 characters (UTF-16 units).","type":"string","x-rich-text":"text"}},"required":["type","id","content"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"section_break"},"id":{"type":"string"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"separator"},"id":{"type":"string"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"true_false"},"id":{"type":"string"},"question":{"type":"string"},"correctAnswer":{"type":"boolean"},"weight":{"type":"number"},"hint":{"type":"string"},"explanation":{"type":"string"}},"required":["type","id","question","correctAnswer","weight"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"short_text"},"id":{"type":"string"},"question":{"type":"string"},"acceptedAnswers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"}},"required":["id","text"],"additionalProperties":false},"minItems":1,"maxItems":100},"weight":{"type":"number"},"hint":{"type":"string"},"explanation":{"type":"string"}},"required":["type","id","question","acceptedAnswers","weight"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"free_text"},"id":{"type":"string"},"question":{"type":"string"}},"required":["type","id","question"],"additionalProperties":false}]},"minItems":1,"maxItems":50},"title":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"settings":{"type":"object","properties":{"attempts_allowed":{"description":"Null is unlimited.","anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}]},"pass_mark":{"description":"Percent needed to pass; null passes any finished sitting.","anyOf":[{"type":"integer","minimum":0,"maximum":100},{"type":"null"}]},"show_answers":{"type":"boolean"}},"additionalProperties":false}},"required":["blocks"],"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/entries/{entry}/quizzes/{quiz}":{"get":{"operationId":"getQuiz","summary":"Reads one quiz with its questions.","tags":["quiz"],"security":[{"bearer":["quiz:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"entry","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"quiz","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Reads one quiz with its questions.","content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"object","properties":{"attachment_id":{"type":"string"},"asset_id":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"blocks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"}},"required":["type","id"],"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}}},"required":["attachment_id","asset_id","title","blocks"]},"question_count":{"description":"How many of its blocks are questions a sitter answers.","type":"number"},"files":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["video","audio","image","pdf","file"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes, null when it has none or is withheld.","anyOf":[{"type":"number"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"description":"Seconds.","anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"url":{"description":"A public file's lasting URL, an image's naming its widths' version as `#v=` once they're made; null for a private one, or one whose bytes haven't landed.","anyOf":[{"type":"string"},{"type":"null"}]},"resized":{"description":"A public image's smaller copies, narrowest first, for a `srcset`; left out until they're made and its width measured, for one kept as uploaded, and for any other file.","type":"array","items":{"type":"object","properties":{"width":{"description":"Its width in pixels, at most the image's own.","type":"integer","minimum":1},"avif":{"description":"A lasting URL to it as AVIF.","type":"string"},"webp":{"description":"A lasting URL to it as WebP.","type":"string"}},"required":["width","avif","webp"]}},"attachment_id":{"description":"The binding a private file opens through; null when the reader can't open it.","anyOf":[{"type":"string"},{"type":"null"}]},"unlocks":{"description":"What unlocks a file its own rules keep from the reader, any one; null for any other file.","anyOf":[{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product_name":{"type":"string"},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]}},"required":["product_id","product_name","tier"]}},{"type":"null"}]},"video":{"description":"A video's subtitles and published AI outputs, where its read lists any and the reader may play it.","type":"object","properties":{"attachment_id":{"type":"string"},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["attachment_id","tracks","outputs"]},"audio":{"description":"An audio file's waveform, subtitles and published AI outputs, where the reader may play it.","type":"object","properties":{"waveform":{"description":"256 levels from 0 to 255, base64, from the file's start to its end; null until drawn, or when it can't be.","anyOf":[{"type":"string"},{"type":"null"}]},"attachment_id":{"description":"The binding its tracks and outputs open through, which a public file carries here alone; null with none.","anyOf":[{"type":"string"},{"type":"null"}]},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["waveform","attachment_id","tracks","outputs"]}},"required":["id","kind","mime","name","bytes","width","height","duration","pages","status","url","attachment_id","unlocks"]}},"sittings":{"type":"number"},"certificates":{"type":"array","items":{"type":"object","properties":{"logo":{"anyOf":[{"type":"object","properties":{"attachment_id":{"type":"string"},"asset_id":{"type":"string"}},"required":["attachment_id","asset_id"]},{"type":"null"}]},"id":{"type":"string"},"product_id":{"type":"string"},"quiz_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"headline_copy":{"type":"string"},"title_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"awarded_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"score_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"out_of_score_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"template":{"type":"string","x-extensible-enum":["classic","framed"]},"accent":{"anyOf":[{"type":"string","x-extensible-enum":["emerald","blue","teal","indigo","purple","pink","red","orange","yellow","gray"]},{"type":"null"}]},"requires_passing":{"description":"Earned by passing the quiz, not by merely finishing it.","type":"boolean"},"earned_on":{"description":"Set on a certificate no quiz awards: finishing every entry of a course, or a check-in at an event, earns it; losing its quiz never makes one.","type":"string","x-extensible-enum":["completion","attendance"]},"shows":{"type":"array","items":{"type":"string","x-extensible-enum":["date","score","qr_code"]}}},"required":["template","accent"]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["logo","id","product_id","quiz_id","headline_copy","title_copy","awarded_copy","reason_copy","score_copy","out_of_score_copy","settings","created_at"]}},"id":{"type":"string"},"entry_id":{"type":"string"},"product_id":{"type":"string"},"version":{"type":"number"},"settings":{"type":"object","properties":{"attempts_allowed":{"anyOf":[{"type":"number"},{"type":"null"}]},"pass_mark":{"anyOf":[{"type":"number"},{"type":"null"}]},"show_answers":{"type":"boolean"}},"required":["attempts_allowed","pass_mark","show_answers"]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["body","question_count","files","sittings","certificates","id","entry_id","product_id","version","settings","created_at","updated_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"patch":{"operationId":"updateQuiz","summary":"Updates a quiz's settings and questions.","tags":["quiz"],"security":[{"bearer":["quiz:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"entry","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"quiz","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Updates a quiz's settings and questions.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"attempts_allowed":{"anyOf":[{"type":"number"},{"type":"null"}]},"pass_mark":{"anyOf":[{"type":"number"},{"type":"null"}]},"show_answers":{"type":"boolean"}},"required":["attempts_allowed","pass_mark","show_answers"]},"product_id":{"type":"string"},"entry_id":{"type":"string"},"version":{"type":"number"},"certificates":{"type":"array","items":{"type":"object","properties":{"logo":{"anyOf":[{"type":"object","properties":{"attachment_id":{"type":"string"},"asset_id":{"type":"string"}},"required":["attachment_id","asset_id"]},{"type":"null"}]},"id":{"type":"string"},"product_id":{"type":"string"},"quiz_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"headline_copy":{"type":"string"},"title_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"awarded_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"score_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"out_of_score_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"template":{"type":"string","x-extensible-enum":["classic","framed"]},"accent":{"anyOf":[{"type":"string","x-extensible-enum":["emerald","blue","teal","indigo","purple","pink","red","orange","yellow","gray"]},{"type":"null"}]},"requires_passing":{"description":"Earned by passing the quiz, not by merely finishing it.","type":"boolean"},"earned_on":{"description":"Set on a certificate no quiz awards: finishing every entry of a course, or a check-in at an event, earns it; losing its quiz never makes one.","type":"string","x-extensible-enum":["completion","attendance"]},"shows":{"type":"array","items":{"type":"string","x-extensible-enum":["date","score","qr_code"]}}},"required":["template","accent"]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["logo","id","product_id","quiz_id","headline_copy","title_copy","awarded_copy","reason_copy","score_copy","out_of_score_copy","settings","created_at"]}},"question_count":{"description":"How many of its blocks are questions a sitter answers.","type":"number"},"sittings":{"type":"number"},"body":{"type":"object","properties":{"attachment_id":{"type":"string"},"asset_id":{"description":"The body asset a later update's `replaces` names.","type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"blocks":{"description":"The questions as written; answered only with `full`.","type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"}},"required":["type","id"],"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}}},"required":["attachment_id","asset_id","title"]},"files":{"description":"The files its static text names, as its save bound them; answered only with `full`.","type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["video","audio","image","pdf","file"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes, null when it has none or is withheld.","anyOf":[{"type":"number"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"description":"Seconds.","anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"url":{"description":"A public file's lasting URL, an image's naming its widths' version as `#v=` once they're made; null for a private one, or one whose bytes haven't landed.","anyOf":[{"type":"string"},{"type":"null"}]},"resized":{"description":"A public image's smaller copies, narrowest first, for a `srcset`; left out until they're made and its width measured, for one kept as uploaded, and for any other file.","type":"array","items":{"type":"object","properties":{"width":{"description":"Its width in pixels, at most the image's own.","type":"integer","minimum":1},"avif":{"description":"A lasting URL to it as AVIF.","type":"string"},"webp":{"description":"A lasting URL to it as WebP.","type":"string"}},"required":["width","avif","webp"]}},"attachment_id":{"description":"The binding a private file opens through; null when the reader can't open it.","anyOf":[{"type":"string"},{"type":"null"}]},"unlocks":{"description":"What unlocks a file its own rules keep from the reader, any one; null for any other file.","anyOf":[{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product_name":{"type":"string"},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]}},"required":["product_id","product_name","tier"]}},{"type":"null"}]},"video":{"description":"A video's subtitles and published AI outputs, where its read lists any and the reader may play it.","type":"object","properties":{"attachment_id":{"type":"string"},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["attachment_id","tracks","outputs"]},"audio":{"description":"An audio file's waveform, subtitles and published AI outputs, where the reader may play it.","type":"object","properties":{"waveform":{"description":"256 levels from 0 to 255, base64, from the file's start to its end; null until drawn, or when it can't be.","anyOf":[{"type":"string"},{"type":"null"}]},"attachment_id":{"description":"The binding its tracks and outputs open through, which a public file carries here alone; null with none.","anyOf":[{"type":"string"},{"type":"null"}]},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["waveform","attachment_id","tracks","outputs"]}},"required":["id","kind","mime","name","bytes","width","height","duration","pages","status","url","attachment_id","unlocks"]}},"created":{"description":"The attachments the write bound: the files its new static text names.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string","x-extensible-enum":["prose","teaser","embed"]},"asset":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}},"required":["id","role","asset"]}}},"required":["id","created_at","updated_at","settings","product_id","entry_id","version","certificates","question_count","sittings","body","created"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"text_format":{"type":"string","enum":["html","markdown"],"default":"html","description":"The format the rich text fields are written in: the rich text format’s HTML, or Markdown converted into it before it is validated. A text already stored in the format (starting with `<rich-text`) is kept as it is either way."},"full":{"description":"Answers the texts, attachments and file lists the short answer leaves out.","type":"boolean","const":true},"title":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"settings":{"type":"object","properties":{"attempts_allowed":{"description":"Null is unlimited.","anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}]},"pass_mark":{"description":"Percent needed to pass; null passes any finished sitting.","anyOf":[{"type":"integer","minimum":0,"maximum":100},{"type":"null"}]},"show_answers":{"type":"boolean"}},"additionalProperties":false},"blocks":{"description":"New questions, for a version nobody sat; a key the schema does not know is refused.","type":"array","items":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","const":"multiple_choice"},"id":{"type":"string"},"question":{"type":"string"},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"}},"required":["id","text"],"additionalProperties":false},"minItems":2,"maxItems":100},"correctOptionId":{"type":"string"},"weight":{"type":"number"},"hint":{"type":"string"},"explanation":{"type":"string"}},"required":["type","id","question","options","correctOptionId","weight"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"scale"},"id":{"type":"string"},"question":{"type":"string"},"min":{"type":"number"},"max":{"type":"number"},"correctValue":{"type":"number"},"weight":{"type":"number"},"hint":{"type":"string"},"explanation":{"type":"string"}},"required":["type","id","question","min","max","correctValue","weight"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"static_text"},"id":{"type":"string"},"content":{"description":"The text a sitter reads, in the rich text format with the blocks a lesson takes, showing a reader at most 500 characters (UTF-16 units).","type":"string","x-rich-text":"text"}},"required":["type","id","content"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"section_break"},"id":{"type":"string"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"separator"},"id":{"type":"string"}},"required":["type","id"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"true_false"},"id":{"type":"string"},"question":{"type":"string"},"correctAnswer":{"type":"boolean"},"weight":{"type":"number"},"hint":{"type":"string"},"explanation":{"type":"string"}},"required":["type","id","question","correctAnswer","weight"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"short_text"},"id":{"type":"string"},"question":{"type":"string"},"acceptedAnswers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"}},"required":["id","text"],"additionalProperties":false},"minItems":1,"maxItems":100},"weight":{"type":"number"},"hint":{"type":"string"},"explanation":{"type":"string"}},"required":["type","id","question","acceptedAnswers","weight"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"free_text"},"id":{"type":"string"},"question":{"type":"string"}},"required":["type","id","question"],"additionalProperties":false}]},"minItems":1,"maxItems":50},"replaces":{"description":"The body asset the new questions replace; another one there refuses them.","type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"newest":{"description":"Refuse unless the version is still the entry's newest.","type":"boolean"}},"additionalProperties":false}}}}},"delete":{"operationId":"deleteQuiz","summary":"Deletes a quiz.","tags":["quiz"],"security":[{"bearer":["quiz:delete"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"entry","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"quiz","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Deletes a quiz.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean","const":true}},"required":["id","deleted"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/quizzes/stats":{"get":{"operationId":"quizStats","summary":"Reads a product's quiz results.","tags":["quiz"],"security":[{"bearer":["quiz:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"from","in":"query","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","schema":{"type":"string","format":"date"}},{"name":"quiz","in":"query","description":"An id.","schema":{"type":"string","minLength":1,"description":"An id."}}],"responses":{"200":{"description":"Reads a product's quiz results.","content":{"application/json":{"schema":{"type":"object","properties":{"entries":{"type":"array","items":{"type":"object","properties":{"total":{"type":"number"},"by_status":{"type":"object","properties":{"started":{"type":"number"},"submitted":{"type":"number"},"passed":{"type":"number"},"failed":{"type":"number"},"forfeited":{"type":"number"}},"required":["started","submitted","passed","failed","forfeited"]},"pass_rate":{"anyOf":[{"type":"number"},{"type":"null"}]},"average_score":{"anyOf":[{"type":"number"},{"type":"null"}]},"average_seconds":{"anyOf":[{"type":"number"},{"type":"null"}]},"entry_id":{"type":"string"}},"required":["total","by_status","pass_rate","average_score","average_seconds","entry_id"]}},"total":{"type":"number"},"by_status":{"type":"object","properties":{"started":{"type":"number"},"submitted":{"type":"number"},"passed":{"type":"number"},"failed":{"type":"number"},"forfeited":{"type":"number"}},"required":["started","submitted","passed","failed","forfeited"]},"pass_rate":{"anyOf":[{"type":"number"},{"type":"null"}]},"average_score":{"anyOf":[{"type":"number"},{"type":"null"}]},"average_seconds":{"anyOf":[{"type":"number"},{"type":"null"}]},"time_zone":{"type":"string"},"from":{"anyOf":[{"type":"string"},{"type":"null"}]},"to":{"anyOf":[{"type":"string"},{"type":"null"}]},"quizzes":{"type":"number"}},"required":["entries","total","by_status","pass_rate","average_score","average_seconds","time_zone","from","to","quizzes"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/entries/{entry}/attempts/clear":{"post":{"operationId":"clearAttempts","summary":"Clears a customer's attempts at an entry's quizzes.","tags":["quiz"],"security":[{"bearer":["quiz:delete"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"entry","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Clears a customer's attempts at an entry's quizzes.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"deleted":{"type":"number"}},"required":["deleted"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customer":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"required":["customer"],"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/certificates/{certificate}":{"patch":{"operationId":"updateCertificate","summary":"Updates a certificate's design and copy.","tags":["certificate"],"security":[{"bearer":["certificate:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"certificate","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Updates a certificate's design and copy.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"logo":{"anyOf":[{"type":"object","properties":{"attachment_id":{"type":"string"},"asset_id":{"type":"string"}},"required":["attachment_id","asset_id"]},{"type":"null"}]},"issued":{"type":"number"},"id":{"type":"string"},"product_id":{"type":"string"},"quiz_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"headline_copy":{"type":"string"},"title_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"awarded_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"score_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"out_of_score_copy":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"template":{"type":"string","x-extensible-enum":["classic","framed"]},"accent":{"anyOf":[{"type":"string","x-extensible-enum":["emerald","blue","teal","indigo","purple","pink","red","orange","yellow","gray"]},{"type":"null"}]},"requires_passing":{"description":"Earned by passing the quiz, not by merely finishing it.","type":"boolean"},"earned_on":{"description":"Set on a certificate no quiz awards: finishing every entry of a course, or a check-in at an event, earns it; losing its quiz never makes one.","type":"string","x-extensible-enum":["completion","attendance"]},"shows":{"type":"array","items":{"type":"string","x-extensible-enum":["date","score","qr_code"]}}},"required":["template","accent"]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["logo","issued","id","product_id","quiz_id","headline_copy","title_copy","awarded_copy","reason_copy","score_copy","out_of_score_copy","settings","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"settings":{"type":"object","properties":{"requires_passing":{"type":"boolean"},"earned_on":{"description":"`completion` on a course, `attendance` (a check-in) on an event.","anyOf":[{"type":"string","enum":["completion","attendance"]},{"type":"null"}]},"shows":{"type":"array","items":{"type":"string","enum":["date","score","qr_code"]},"maxItems":3},"template":{"type":"string","enum":["classic","framed"]},"accent":{"description":"Null clears it, so it prints in the store's color.","anyOf":[{"type":"string","enum":["emerald","blue","teal","indigo","purple","pink","red","orange","yellow","gray"]},{"type":"null"}]}},"additionalProperties":false},"headline_copy":{"type":"string","minLength":1,"maxLength":500},"title_copy":{"anyOf":[{"type":"string","minLength":1,"maxLength":500},{"type":"null"}]},"quiz":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"null"}]},"awarded_copy":{"anyOf":[{"type":"string","minLength":1,"maxLength":500},{"type":"null"}]},"reason_copy":{"anyOf":[{"type":"string","minLength":1,"maxLength":500},{"type":"null"}]},"score_copy":{"anyOf":[{"type":"string","minLength":1,"maxLength":500},{"type":"null"}]},"out_of_score_copy":{"anyOf":[{"type":"string","minLength":1,"maxLength":500},{"type":"null"}]}},"additionalProperties":false}}}}},"delete":{"operationId":"deleteCertificate","summary":"Deletes a certificate never issued.","tags":["certificate"],"security":[{"bearer":["certificate:delete"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"certificate","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Deletes a certificate never issued.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean","const":true}},"required":["id","deleted"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/certificates/issues/{issue}/revoke":{"post":{"operationId":"revokeCertificateIssue","summary":"Revokes an issued certificate.","tags":["certificate"],"security":[{"bearer":["certificate:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"issue","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Revokes an issued certificate.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"certificate_id":{"type":"string"},"customer_id":{"type":"string"},"score":{"anyOf":[{"type":"number"},{"type":"null"}]},"attempt":{"anyOf":[{"type":"number"},{"type":"null"}]},"issued_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revoked_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","product_id","certificate_id","customer_id","score","attempt","issued_at","revoked_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/attendees":{"get":{"operationId":"listEventAttendees","summary":"Pages an event's guest list: one row per person, going or canceled, with their tier and how they got their ticket.","tags":["customer"],"security":[{"bearer":["customer:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","description":"Sorted by canceled, rows without a value come last either way.","schema":{"type":"string","enum":["registered","canceled"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"search","in":"query","schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"facets","in":"query","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["status","cancel_reason"]}}}],"responses":{"200":{"description":"Pages an event's guest list: one row per person, going or canceled, with their tier and how they got their ticket.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"customer_id":{"type":"string"},"status":{"description":"`going` while a grant holds, `pending` while their request waits for the seller's approval, `waitlisted` while they wait for a seat, `canceled` once none of these holds.","type":"string","x-extensible-enum":["pending","going","waitlisted","canceled"]},"cancel_reason":{"description":"Why they no longer hold the event: `refunded`, `revoked`, `expired`, `declined`, or `canceled` when the seller canceled it; null unless canceled.","anyOf":[{"type":"string","x-extensible-enum":["expired","revoked","refunded","canceled","declined"]},{"type":"null"}]},"tier":{"description":"The tier their access opens, else the one it last opened; null for access with no tier.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]},"source":{"description":"What gave the grant that admits them: `checkout`, `payment`, `subscription`, `automation`, `manual` or `api`; `waitlist` for a waitlist entry no grant admits yet.","type":"string","x-extensible-enum":["checkout","api","manual","subscription","payment","automation","waitlist"]},"grant_id":{"description":"The grant that admits them, else the one that ended last; null while a request waits.","anyOf":[{"type":"string"},{"type":"null"}]},"order_id":{"description":"The order behind that grant's settlement; null for a grant no order paid.","anyOf":[{"type":"string"},{"type":"null"}]},"registered_at":{"description":"When their current stretch of access began, or the one that ended for a canceled attendee.","type":"string"},"canceled_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"customer":{"description":"Who they are, `erased` once their details are wiped.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"bought_by":{"description":"For a guest someone else bought a ticket for: the buyer and the order; null otherwise.","anyOf":[{"type":"object","properties":{"customer_id":{"type":"string"},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"order_id":{"type":"string"}},"required":["customer_id","customer","order_id"]},{"type":"null"}]},"guests":{"description":"How many guests they bought tickets for who still hold them.","type":"number"},"answers":{"description":"Their answers to the product's registration questions, in the questions' order; a question left unanswered is absent.","type":"array","items":{"type":"object","properties":{"question_id":{"type":"string"},"value":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["question_id","value"]}},"answered_by":{"description":"Who gave `answers`: `buyer` for a guest with none of their own, showing their buyer's answers to the product; else `attendee`.","type":"string","x-extensible-enum":["attendee","buyer"]},"check_ins":{"description":"The sessions they were let in at, earliest first.","type":"array","items":{"type":"object","properties":{"id":{"description":"What an automation's run names as its trigger.","type":"string"},"session_id":{"type":"string"},"checked_in_at":{"type":"string"}},"required":["id","session_id","checked_in_at"]}}},"required":["id","product_id","customer_id","status","cancel_reason","tier","source","grant_id","order_id","registered_at","canceled_at","customer","bought_by","guests","answers","answered_by","check_ins"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/attendees/stats":{"get":{"operationId":"eventAttendeeStats","summary":"Counts an event's attendees: going, canceled by reason, going by tier, and the spots its capacity leaves.","tags":["customer"],"security":[{"bearer":["customer:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Counts an event's attendees: going, canceled by reason, going by tier, and the spots its capacity leaves.","content":{"application/json":{"schema":{"type":"object","properties":{"going":{"type":"number"},"pending":{"description":"Who waits for the seller's approval.","type":"number"},"waitlisted":{"description":"Who waits on the waitlist for a seat.","type":"number"},"canceled":{"type":"number"},"canceled_by_reason":{"type":"object","properties":{"expired":{"type":"number"},"revoked":{"type":"number"},"refunded":{"type":"number"},"canceled":{"type":"number"},"declined":{"type":"number"}},"required":["expired","revoked","refunded","canceled","declined"]},"going_by_tier":{"description":"Who is going per tier, highest first; a null tier is access with no tier.","type":"array","items":{"type":"object","properties":{"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]},"going":{"type":"number"}},"required":["tier","going"]}},"checked_in_by_session":{"description":"How many were let in at each session that let anyone in.","type":"array","items":{"type":"object","properties":{"session_id":{"type":"string"},"checked_in":{"type":"number"}},"required":["session_id","checked_in"]}},"capacity":{"description":"The event's own capacity; null when it sets none, or stores one no write could make.","anyOf":[{"type":"number"},{"type":"null"}]},"remaining":{"description":"The seats left to sell, as checkout counts them (a grant takes none), held to each ticket type's capacity too; null unless the event is capped, or at least one ticket type is on sale and every one is; none once it is canceled.","anyOf":[{"type":"number"},{"type":"null"}]},"held_by_requests":{"description":"Of the seats taken, those requests waiting for approval hold.","type":"integer","minimum":0},"subscriptions":{"description":"Subscriptions to the event still running, which a cancellation stops billing.","type":"integer","minimum":0}},"required":["going","pending","waitlisted","canceled","canceled_by_reason","going_by_tier","checked_in_by_session","capacity","remaining","held_by_requests","subscriptions"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/questions":{"get":{"operationId":"listProductQuestions","summary":"Pages the registration questions a product asks its buyers in checkout, in order.","tags":["product"],"security":[{"bearer":["product:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["position"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Pages the registration questions a product asks its buyers in checkout, in order.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"position":{"description":"Where it shows among the product's questions, from zero.","type":"number"},"kind":{"description":"`text`, `long_text`, `select`, `multi_select` or `checkbox`.","type":"string","x-extensible-enum":["text","select","long_text","multi_select","checkbox"]},"preset":{"description":"The standard detail it asks for (`name`, `phone`, `company` or `address`), or null for one of the seller's own.","anyOf":[{"type":"string","x-extensible-enum":["name","phone","address","company"]},{"type":"null"}]},"label":{"type":"string"},"required":{"description":"Whether checkout asks for an answer before payment; a required checkbox must be ticked.","type":"boolean"},"options":{"description":"A select's options, in order; null for any other kind.","anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"pattern":{"description":"The pattern a text answer must match whole, or null for none.","anyOf":[{"type":"string"},{"type":"null"}]},"example":{"description":"An answer that fits the pattern, which checkout shows as the format to follow; null for none.","anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","product_id","position","kind","preset","label","required","options","pattern","example","created_at","updated_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"post":{"operationId":"createProductQuestion","summary":"Adds a registration question to a product, its own or a standard detail: a text, a select or a checkbox, required or not.","tags":["product"],"security":[{"bearer":["product:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"201":{"description":"Adds a registration question to a product, its own or a standard detail: a text, a select or a checkbox, required or not.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"position":{"description":"Where it shows among the product's questions, from zero.","type":"number"},"kind":{"description":"`text`, `long_text`, `select`, `multi_select` or `checkbox`.","type":"string","x-extensible-enum":["text","select","long_text","multi_select","checkbox"]},"preset":{"description":"The standard detail it asks for (`name`, `phone`, `company` or `address`), or null for one of the seller's own.","anyOf":[{"type":"string","x-extensible-enum":["name","phone","address","company"]},{"type":"null"}]},"label":{"type":"string"},"required":{"description":"Whether checkout asks for an answer before payment; a required checkbox must be ticked.","type":"boolean"},"options":{"description":"A select's options, in order; null for any other kind.","anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"pattern":{"description":"The pattern a text answer must match whole, or null for none.","anyOf":[{"type":"string"},{"type":"null"}]},"example":{"description":"An answer that fits the pattern, which checkout shows as the format to follow; null for none.","anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","product_id","position","kind","preset","label","required","options","pattern","example","created_at","updated_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"description":"What the buyer answers with: a short or long text, one option, any options, or a tick; a preset's own when unset.","type":"string","enum":["text","select","long_text","multi_select","checkbox"]},"preset":{"description":"A standard detail to ask for: `name`, `phone`, `company` or `address`, each once per product; it sets the kind, and the label and pattern unless given.","type":"string","enum":["name","phone","address","company"]},"label":{"description":"What the buyer is asked, trimmed, with no line break or control character; required unless a preset names it.","type":"string","minLength":1,"maxLength":200},"required":{"description":"Whether checkout asks for an answer before payment; a required checkbox must be ticked. False when unset.","type":"boolean"},"options":{"description":"A select's or a multi select's options, in order and distinct, each trimmed with no line break or control character; refused for any other kind.","type":"array","items":{"type":"string"},"minItems":2,"maxItems":20},"pattern":{"description":"A text answer's pattern, trimmed and matched against the whole answer: literals, `.`, classes, `\\d \\w \\s`, groups, `|` and repeats up to 100; refused for any other kind and for what can't be matched safely.","anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"example":{"description":"An answer that fits the pattern, trimmed with no line break or control character, which checkout shows buyers as the format to follow; refused without a pattern or when the pattern doesn't match it, and cleared with the pattern.","anyOf":[{"type":"string","minLength":1,"maxLength":100},{"type":"null"}]},"position":{"description":"Where it goes among the product's questions, from zero; last when unset.","type":"integer","minimum":0,"maximum":19}},"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/questions/{question}":{"patch":{"operationId":"updateProductQuestion","summary":"Rewords a product question, makes it required or not, changes its options or pattern, or moves it.","tags":["product"],"security":[{"bearer":["product:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"question","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Rewords a product question, makes it required or not, changes its options or pattern, or moves it.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"position":{"description":"Where it shows among the product's questions, from zero.","type":"number"},"kind":{"description":"`text`, `long_text`, `select`, `multi_select` or `checkbox`.","type":"string","x-extensible-enum":["text","select","long_text","multi_select","checkbox"]},"preset":{"description":"The standard detail it asks for (`name`, `phone`, `company` or `address`), or null for one of the seller's own.","anyOf":[{"type":"string","x-extensible-enum":["name","phone","address","company"]},{"type":"null"}]},"label":{"type":"string"},"required":{"description":"Whether checkout asks for an answer before payment; a required checkbox must be ticked.","type":"boolean"},"options":{"description":"A select's options, in order; null for any other kind.","anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"pattern":{"description":"The pattern a text answer must match whole, or null for none.","anyOf":[{"type":"string"},{"type":"null"}]},"example":{"description":"An answer that fits the pattern, which checkout shows as the format to follow; null for none.","anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","product_id","position","kind","preset","label","required","options","pattern","example","created_at","updated_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"position":{"description":"Where it goes among the product's questions, from zero; last when unset.","type":"integer","minimum":0,"maximum":19},"label":{"description":"What the buyer is asked, trimmed, with no line break or control character; required unless a preset names it.","type":"string","minLength":1,"maxLength":200},"required":{"description":"Whether checkout asks for an answer before payment; a required checkbox must be ticked. False when unset.","type":"boolean"},"options":{"description":"A select's or a multi select's options, in order and distinct, each trimmed with no line break or control character; refused for any other kind.","type":"array","items":{"type":"string"},"minItems":2,"maxItems":20},"pattern":{"description":"A text answer's pattern, trimmed and matched against the whole answer: literals, `.`, classes, `\\d \\w \\s`, groups, `|` and repeats up to 100; refused for any other kind and for what can't be matched safely.","anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"example":{"description":"An answer that fits the pattern, trimmed with no line break or control character, which checkout shows buyers as the format to follow; refused without a pattern or when the pattern doesn't match it, and cleared with the pattern.","anyOf":[{"type":"string","minLength":1,"maxLength":100},{"type":"null"}]},"from_position":{"description":"Where the caller last read it; one moved since is refused, so two moves never compound.","type":"integer","minimum":0,"maximum":19}},"additionalProperties":false}}}}},"delete":{"operationId":"deleteProductQuestion","summary":"Stops asking a product question, dropping its answers.","tags":["product"],"security":[{"bearer":["product:delete"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"question","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Stops asking a product question, dropping its answers.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean","const":true}},"required":["id","deleted"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/customers/{customer}/answers":{"get":{"operationId":"listCustomerAnswers","summary":"Reads a customer's answers to each product's registration questions, latest answered first.","tags":["customer"],"security":[{"bearer":["customer:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"customer","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"product","in":"query","description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1,"description":"An id, or `slug:<slug>`."}}],"responses":{"200":{"description":"Reads a customer's answers to each product's registration questions, latest answered first.","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"description":"How many products hold the customer's answers, past the first 100 too.","type":"number"},"items":{"type":"array","items":{"type":"object","properties":{"product":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"}},"required":["id","title"]},"answers":{"description":"Each standing answer in the questions' order, with what was asked.","type":"array","items":{"type":"object","properties":{"question_id":{"type":"string"},"label":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["text","select","long_text","multi_select","checkbox"]},"preset":{"anyOf":[{"type":"string","x-extensible-enum":["name","phone","address","company"]},{"type":"null"}]},"value":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["question_id","label","kind","preset","value"]}}},"required":["product","answers"]}}},"required":["total","items"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/customers/{customer}/answers":{"put":{"operationId":"setCustomerAnswers","summary":"Answers a product's registration questions for a customer who holds it, such as answers they gave elsewhere.","tags":["customer"],"security":[{"bearer":["customer:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"customer","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Answers a product's registration questions for a customer who holds it, such as answers they gave elsewhere.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"product_id":{"type":"string"},"customer_id":{"type":"string"},"answers":{"description":"The customer's answers in the questions' order, read back for a caller holding `customer:read`; none for anyone else.","type":"array","items":{"type":"object","properties":{"question_id":{"type":"string"},"value":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["question_id","value"]}}},"required":["product_id","customer_id","answers"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"answers":{"description":"One answer per question; a question left out keeps what it holds.","type":"array","items":{"type":"object","properties":{"question":{"type":"string","maxLength":64},"value":{"description":"A trimmed text for a `text` (one line, at most 300) or `long_text` (at most 3000) question, an option for a `select`, options for a `multi_select`, a boolean for a `checkbox`; null or a blank text clears an optional one.","anyOf":[{"type":"boolean"},{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"null"}]}},"required":["question","value"],"additionalProperties":false},"maxItems":20}},"required":["answers"],"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/attendees/check_in":{"post":{"operationId":"checkInEventAttendee","summary":"Lets an attendee in at one of an event's sessions by their ticket's code or their guest list row, once a session; answers who they are, and whether they were let in now, earlier, or hold no ticket to it.","tags":["attendee"],"security":[{"bearer":["attendee:checkin"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Lets an attendee in at one of an event's sessions by their ticket's code or their guest list row, once a session; answers who they are, and whether they were let in now, earlier, or hold no ticket to it.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"checked_in":{"type":"number"},"going":{"type":"number"},"result":{"description":"`checked_in` when this call let them in, `already_checked_in` when an earlier one had, `not_going` when they hold no ticket to it, no more or not yet.","type":"string","x-extensible-enum":["checked_in","already_checked_in","not_going"]},"attendee":{"type":"object","properties":{"id":{"type":"string"},"status":{"description":"`going` while a grant holds, `pending` or `waitlisted` while their request waits, `canceled` once none does.","type":"string","x-extensible-enum":["pending","going","waitlisted","canceled"]},"cancel_reason":{"description":"Why they no longer hold the event: `refunded`, `revoked`, `expired`, `declined`, or `canceled` when the seller canceled it; null unless canceled.","anyOf":[{"type":"string","x-extensible-enum":["expired","revoked","refunded","canceled","declined"]},{"type":"null"}]},"tier":{"description":"Their ticket type; null for access with no tier.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]},"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","erased"]},{"type":"null"}]}},"required":["id","status","cancel_reason","tier","customer"]},"check_in":{"description":"Their check-in at the session; null while they have none.","anyOf":[{"type":"object","properties":{"id":{"description":"What an automation's run names as its trigger.","type":"string"},"session_id":{"type":"string"},"checked_in_at":{"type":"string"},"checked_in_by":{"description":"The member who let them in, a user id; null for an API token.","anyOf":[{"type":"string"},{"type":"null"}]},"token_id":{"description":"The API token that let them in; null for a member signed in.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","session_id","checked_in_at","checked_in_by","token_id"]},{"type":"null"}]}},"required":["checked_in","going","result","attendee","check_in"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"session":{"description":"The session they are let in at.","type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"ticket_code":{"description":"The code their ticket's QR code holds, as scanned or typed; give this or `attendee`.","type":"string","minLength":1,"maxLength":64},"attendee":{"description":"The attendee, as the guest list names them; give this or `ticket_code`.","type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false}},"required":["session"],"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/attendees/{attendee}/check_in":{"delete":{"operationId":"undoEventAttendeeCheckIn","summary":"Takes back an attendee's check-in at an event's session.","tags":["attendee"],"security":[{"bearer":["attendee:checkin"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"attendee","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"session","in":"query","required":true,"description":"An id.","schema":{"type":"string","minLength":1,"description":"An id."}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Takes back an attendee's check-in at an event's session.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"checked_in":{"type":"number"},"going":{"type":"number"},"attendee_id":{"type":"string"},"session_id":{"type":"string"},"undone":{"type":"boolean","const":true}},"required":["checked_in","going","attendee_id","session_id","undone"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/attendees/check_in/stats":{"get":{"operationId":"eventCheckInStats","summary":"Counts an event's door: who is going, and each session with how many were let in.","tags":["attendee"],"security":[{"bearer":["attendee:checkin"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Counts an event's door: who is going, and each session with how many were let in.","content":{"application/json":{"schema":{"type":"object","properties":{"going":{"type":"number"},"sessions":{"description":"Every session, earliest first, with how many were let in.","type":"array","items":{"type":"object","properties":{"place":{"description":"Where it takes place on one line, as a calendar shows it; null for neither a place nor an online label.","anyOf":[{"type":"string"},{"type":"null"}]},"checked_in":{"type":"number"},"id":{"type":"string"},"product_id":{"type":"string"},"starts_at":{"type":"string"},"ends_at":{"type":"string"},"time_zone":{"description":"An IANA time zone, e.g. `Europe/Rome`.","type":"string"},"venue":{"description":"Where it takes place in person, or null for none.","anyOf":[{"type":"string"},{"type":"null"}]},"online_label":{"description":"How it is joined online, e.g. `Zoom`, or null for none.","anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["place","checked_in","id","product_id","starts_at","ends_at","time_zone","venue","online_label","created_at","updated_at"]}}},"required":["going","sessions"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/check_in":{"get":{"operationId":"listCheckInEvents","summary":"Lists the events with a session held in person still to run or ended in the last 12 hours, soonest first, each with who is going and how many were let in.","tags":["attendee"],"security":[{"bearer":["attendee:checkin"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Lists the events with a session held in person still to run or ended in the last 12 hours, soonest first, each with who is going and how many were let in.","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"description":"Soonest session first, at most 50 events.","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"title":{"type":"string"},"going":{"type":"number"},"sessions":{"description":"Its sessions at a venue still to run or just run, earliest first, with how many were let in.","type":"array","items":{"type":"object","properties":{"place":{"description":"Where it takes place on one line, as a calendar shows it; null for neither a place nor an online label.","anyOf":[{"type":"string"},{"type":"null"}]},"checked_in":{"type":"number"},"id":{"type":"string"},"product_id":{"type":"string"},"starts_at":{"type":"string"},"ends_at":{"type":"string"},"time_zone":{"description":"An IANA time zone, e.g. `Europe/Rome`.","type":"string"},"venue":{"description":"Where it takes place in person, or null for none.","anyOf":[{"type":"string"},{"type":"null"}]},"online_label":{"description":"How it is joined online, e.g. `Zoom`, or null for none.","anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["place","checked_in","id","product_id","starts_at","ends_at","time_zone","venue","online_label","created_at","updated_at"]}}},"required":["id","slug","title","going","sessions"]}}},"required":["items"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/requests":{"get":{"operationId":"listProductRequests","summary":"Pages a product's requests: buyers waiting for approval, an event's waitlist, and those decided.","tags":["customer"],"security":[{"bearer":["customer:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["created","latest"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"search","in":"query","schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"facets","in":"query","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["status"]}}}],"responses":{"200":{"description":"Pages a product's requests: buyers waiting for approval, an event's waitlist, and those decided.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"customer_id":{"type":"string"},"status":{"description":"`pending` until the seller decides, `waitlisted` while it waits for a seat, then `approved` or `declined`.","type":"string","x-extensible-enum":["pending","waitlisted","declined","approved"]},"tier":{"description":"The tier asked for; null for none.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]},"price_id":{"description":"The price asked at.","anyOf":[{"type":"string"},{"type":"null"}]},"payment":{"description":"A paid request's payment: `saved` while its card waits to be charged on approval, `held` while its total is held on the card, `charging` once approved, `due` from the buyer once a charge failed or found no card; null for a free one or once decided.","anyOf":[{"type":"string","x-extensible-enum":["due","held","saved","charging"]},{"type":"null"}]},"hold_expires_at":{"description":"When a `held` request's card hold is released, closing it as expired unless decided first; null otherwise.","anyOf":[{"type":"string"},{"type":"null"}]},"quantity":{"description":"How many tickets it asks for.","type":"integer","minimum":1},"order_item_id":{"description":"The order line that asked, or the one a promotion recorded; null while on a waitlist.","anyOf":[{"type":"string"},{"type":"null"}]},"grant_id":{"description":"The grant an approval gave.","anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string"},"decided_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"closed_reason":{"description":"`expired` for a request declined because its card hold was released before anyone decided; null otherwise.","anyOf":[{"type":"string","x-extensible-enum":["expired"]},{"type":"null"}]},"customer":{"description":"Who they are, `erased` once their details are wiped.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"answers":{"description":"Their answers to the product's registration questions, in the questions' order; none without `customer:read`.","type":"array","items":{"type":"object","properties":{"question_id":{"type":"string"},"value":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["question_id","value"]}}},"required":["id","product_id","customer_id","status","tier","price_id","payment","hold_expires_at","quantity","order_item_id","grant_id","created_at","decided_at","closed_reason","customer","answers"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/requests/{request}/approve":{"post":{"operationId":"approveProductRequest","summary":"Approves a pending request: the buyer is granted what they asked for, on the seats their order holds.","tags":["customer"],"security":[{"bearer":["customer:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"request","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Approves a pending request: the buyer is granted what they asked for, on the seats their order holds.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"customer_id":{"type":"string"},"status":{"description":"`pending` until the seller decides, `waitlisted` while it waits for a seat, then `approved` or `declined`.","type":"string","x-extensible-enum":["pending","waitlisted","declined","approved"]},"tier":{"description":"The tier asked for; null for none.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]},"price_id":{"description":"The price asked at.","anyOf":[{"type":"string"},{"type":"null"}]},"payment":{"description":"A paid request's payment: `saved` while its card waits to be charged on approval, `held` while its total is held on the card, `charging` once approved, `due` from the buyer once a charge failed or found no card; null for a free one or once decided.","anyOf":[{"type":"string","x-extensible-enum":["due","held","saved","charging"]},{"type":"null"}]},"hold_expires_at":{"description":"When a `held` request's card hold is released, closing it as expired unless decided first; null otherwise.","anyOf":[{"type":"string"},{"type":"null"}]},"quantity":{"description":"How many tickets it asks for.","type":"integer","minimum":1},"order_item_id":{"description":"The order line that asked, or the one a promotion recorded; null while on a waitlist.","anyOf":[{"type":"string"},{"type":"null"}]},"grant_id":{"description":"The grant an approval gave.","anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string"},"decided_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"closed_reason":{"description":"`expired` for a request declined because its card hold was released before anyone decided; null otherwise.","anyOf":[{"type":"string","x-extensible-enum":["expired"]},{"type":"null"}]},"customer":{"description":"Who they are, `erased` once their details are wiped.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"answers":{"description":"Their answers to the product's registration questions, in the questions' order; none without `customer:read`.","type":"array","items":{"type":"object","properties":{"question_id":{"type":"string"},"value":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["question_id","value"]}}},"required":["id","product_id","customer_id","status","tier","price_id","payment","hold_expires_at","quantity","order_item_id","grant_id","created_at","decided_at","closed_reason","customer","answers"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/requests/{request}/decline":{"post":{"operationId":"declineProductRequest","summary":"Declines a pending request or a waitlist place, giving back any seats it holds.","tags":["customer"],"security":[{"bearer":["customer:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"request","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Declines a pending request or a waitlist place, giving back any seats it holds.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"customer_id":{"type":"string"},"status":{"description":"`pending` until the seller decides, `waitlisted` while it waits for a seat, then `approved` or `declined`.","type":"string","x-extensible-enum":["pending","waitlisted","declined","approved"]},"tier":{"description":"The tier asked for; null for none.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]},"price_id":{"description":"The price asked at.","anyOf":[{"type":"string"},{"type":"null"}]},"payment":{"description":"A paid request's payment: `saved` while its card waits to be charged on approval, `held` while its total is held on the card, `charging` once approved, `due` from the buyer once a charge failed or found no card; null for a free one or once decided.","anyOf":[{"type":"string","x-extensible-enum":["due","held","saved","charging"]},{"type":"null"}]},"hold_expires_at":{"description":"When a `held` request's card hold is released, closing it as expired unless decided first; null otherwise.","anyOf":[{"type":"string"},{"type":"null"}]},"quantity":{"description":"How many tickets it asks for.","type":"integer","minimum":1},"order_item_id":{"description":"The order line that asked, or the one a promotion recorded; null while on a waitlist.","anyOf":[{"type":"string"},{"type":"null"}]},"grant_id":{"description":"The grant an approval gave.","anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string"},"decided_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"closed_reason":{"description":"`expired` for a request declined because its card hold was released before anyone decided; null otherwise.","anyOf":[{"type":"string","x-extensible-enum":["expired"]},{"type":"null"}]},"customer":{"description":"Who they are, `erased` once their details are wiped.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"answers":{"description":"Their answers to the product's registration questions, in the questions' order; none without `customer:read`.","type":"array","items":{"type":"object","properties":{"question_id":{"type":"string"},"value":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["question_id","value"]}}},"required":["id","product_id","customer_id","status","tier","price_id","payment","hold_expires_at","quantity","order_item_id","grant_id","created_at","decided_at","closed_reason","customer","answers"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/requests/{request}/promote":{"post":{"operationId":"promoteProductRequest","summary":"Lets a waitlisted buyer in once the event has their seats: a free order takes them and the buyer is granted at once.","tags":["customer"],"security":[{"bearer":["customer:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"request","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Lets a waitlisted buyer in once the event has their seats: a free order takes them and the buyer is granted at once.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"customer_id":{"type":"string"},"status":{"description":"`pending` until the seller decides, `waitlisted` while it waits for a seat, then `approved` or `declined`.","type":"string","x-extensible-enum":["pending","waitlisted","declined","approved"]},"tier":{"description":"The tier asked for; null for none.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]},"price_id":{"description":"The price asked at.","anyOf":[{"type":"string"},{"type":"null"}]},"payment":{"description":"A paid request's payment: `saved` while its card waits to be charged on approval, `held` while its total is held on the card, `charging` once approved, `due` from the buyer once a charge failed or found no card; null for a free one or once decided.","anyOf":[{"type":"string","x-extensible-enum":["due","held","saved","charging"]},{"type":"null"}]},"hold_expires_at":{"description":"When a `held` request's card hold is released, closing it as expired unless decided first; null otherwise.","anyOf":[{"type":"string"},{"type":"null"}]},"quantity":{"description":"How many tickets it asks for.","type":"integer","minimum":1},"order_item_id":{"description":"The order line that asked, or the one a promotion recorded; null while on a waitlist.","anyOf":[{"type":"string"},{"type":"null"}]},"grant_id":{"description":"The grant an approval gave.","anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string"},"decided_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"closed_reason":{"description":"`expired` for a request declined because its card hold was released before anyone decided; null otherwise.","anyOf":[{"type":"string","x-extensible-enum":["expired"]},{"type":"null"}]},"customer":{"description":"Who they are, `erased` once their details are wiped.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"answers":{"description":"Their answers to the product's registration questions, in the questions' order; none without `customer:read`.","type":"array","items":{"type":"object","properties":{"question_id":{"type":"string"},"value":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["question_id","value"]}}},"required":["id","product_id","customer_id","status","tier","price_id","payment","hold_expires_at","quantity","order_item_id","grant_id","created_at","decided_at","closed_reason","customer","answers"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/sessions":{"get":{"operationId":"listEventSessions","summary":"Pages an event's sessions, earliest first.","tags":["product"],"security":[{"bearer":["product:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["starts"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Pages an event's sessions, earliest first.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"starts_at":{"type":"string"},"ends_at":{"type":"string"},"time_zone":{"description":"An IANA time zone, e.g. `Europe/Rome`.","type":"string"},"venue":{"description":"Where it takes place in person, or null for none.","anyOf":[{"type":"string"},{"type":"null"}]},"online_label":{"description":"How it is joined online, e.g. `Zoom`, or null for none.","anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","product_id","starts_at","ends_at","time_zone","venue","online_label","created_at","updated_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"post":{"operationId":"createEventSession","summary":"Adds a session to an event, with its start, end, time zone and place.","tags":["product"],"security":[{"bearer":["product:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"201":{"description":"Adds a session to an event, with its start, end, time zone and place.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"starts_at":{"type":"string"},"ends_at":{"type":"string"},"time_zone":{"description":"An IANA time zone, e.g. `Europe/Rome`.","type":"string"},"venue":{"description":"Where it takes place in person, or null for none.","anyOf":[{"type":"string"},{"type":"null"}]},"online_label":{"description":"How it is joined online, e.g. `Zoom`, or null for none.","anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","product_id","starts_at","ends_at","time_zone","venue","online_label","created_at","updated_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"starts_at":{"description":"When it starts, an ISO 8601 timestamp.","type":"string","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})(?:T(\\d{2}):(\\d{2})(?::(\\d{2})(?:\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"},"ends_at":{"description":"When it ends, after it starts, an ISO 8601 timestamp.","type":"string","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})(?:T(\\d{2}):(\\d{2})(?::(\\d{2})(?:\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"},"time_zone":{"description":"The IANA time zone it is shown in, e.g. `Europe/Rome`.","type":"string","minLength":1,"maxLength":64},"venue":{"description":"Where it takes place in person, trimmed, with no line break or control character.","anyOf":[{"type":"string","minLength":1,"maxLength":200,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},{"type":"null"}]},"online_label":{"description":"How it is joined online, e.g. `Zoom`: a label everyone sees, never a link, trimmed, with no line break or control character.","anyOf":[{"type":"string","minLength":1,"maxLength":100,"pattern":"^(?!.*(?::\\/\\/|[\\w-]+(?:\\.[\\w-]+)+\\/))[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},{"type":"null"}]}},"required":["starts_at","ends_at","time_zone"],"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/sessions/{session}":{"patch":{"operationId":"updateEventSession","summary":"Moves an event session or changes its place.","tags":["product"],"security":[{"bearer":["product:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"session","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Moves an event session or changes its place.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"starts_at":{"type":"string"},"ends_at":{"type":"string"},"time_zone":{"description":"An IANA time zone, e.g. `Europe/Rome`.","type":"string"},"venue":{"description":"Where it takes place in person, or null for none.","anyOf":[{"type":"string"},{"type":"null"}]},"online_label":{"description":"How it is joined online, e.g. `Zoom`, or null for none.","anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","product_id","starts_at","ends_at","time_zone","venue","online_label","created_at","updated_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"starts_at":{"description":"When it starts, an ISO 8601 timestamp.","type":"string","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})(?:T(\\d{2}):(\\d{2})(?::(\\d{2})(?:\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"},"ends_at":{"description":"When it ends, after it starts, an ISO 8601 timestamp.","type":"string","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})(?:T(\\d{2}):(\\d{2})(?::(\\d{2})(?:\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"},"time_zone":{"description":"The IANA time zone it is shown in, e.g. `Europe/Rome`.","type":"string","minLength":1,"maxLength":64},"venue":{"description":"Where it takes place in person, trimmed, with no line break or control character.","anyOf":[{"type":"string","minLength":1,"maxLength":200,"pattern":"^[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},{"type":"null"}]},"online_label":{"description":"How it is joined online, e.g. `Zoom`: a label everyone sees, never a link, trimmed, with no line break or control character.","anyOf":[{"type":"string","minLength":1,"maxLength":100,"pattern":"^(?!.*(?::\\/\\/|[\\w-]+(?:\\.[\\w-]+)+\\/))[^\\s\\u0000-\\u001f\\u007f-\\u009f]([^\\u0000-\\u001f\\u007f-\\u009f\\u2028\\u2029]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$"},{"type":"null"}]}},"additionalProperties":false}}}}},"delete":{"operationId":"deleteEventSession","summary":"Takes a session off an event's schedule.","tags":["product"],"security":[{"bearer":["product:delete"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"session","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Takes a session off an event's schedule.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean","const":true}},"required":["id","deleted"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/cancel":{"post":{"operationId":"cancelEvent","summary":"Cancels an event: it stops selling, its sessions ahead come off the schedule, and every attendee is told and refunded in full.","tags":["transaction"],"security":[{"bearer":["transaction:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Cancels an event: it stops selling, its sessions ahead come off the schedule, and every attendee is told and refunded in full.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"product_id":{"type":"string"},"canceled_at":{"type":"string"},"subscriptions":{"description":"Subscriptions to the event it stops billing.","type":"integer","minimum":0},"finished_at":{"description":"When every holder had lost their access and was owed their mail and refunds; null while that runs.","anyOf":[{"type":"string"},{"type":"null"}]},"removed":{"description":"The sessions ahead it took off the schedule.","type":"array","items":{"type":"object","properties":{"id":{"description":"The session's id, which a calendar knows it by.","type":"string"},"starts_at":{"type":"string"},"ends_at":{"type":"string"},"time_zone":{"type":"string"},"venue":{"anyOf":[{"type":"string"},{"type":"null"}]},"online_label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","starts_at","ends_at","time_zone","venue","online_label"]}},"refunds":{"type":"object","properties":{"pending":{"type":"number"},"failed":{"type":"number"},"manual":{"type":"number"},"refunded":{"type":"number"}},"required":["pending","failed","manual","refunded"]}},"required":["product_id","canceled_at","subscriptions","finished_at","removed","refunds"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/cancellation":{"get":{"operationId":"getEventCancellation","summary":"Reads an event's cancellation and its refunds by status; null while the event stands.","tags":["product"],"security":[{"bearer":["product:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Reads an event's cancellation and its refunds by status; null while the event stands.","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"product_id":{"type":"string"},"canceled_at":{"type":"string"},"subscriptions":{"description":"Subscriptions to the event it stops billing.","type":"integer","minimum":0},"finished_at":{"description":"When every holder had lost their access and was owed their mail and refunds; null while that runs.","anyOf":[{"type":"string"},{"type":"null"}]},"removed":{"description":"The sessions ahead it took off the schedule.","type":"array","items":{"type":"object","properties":{"id":{"description":"The session's id, which a calendar knows it by.","type":"string"},"starts_at":{"type":"string"},"ends_at":{"type":"string"},"time_zone":{"type":"string"},"venue":{"anyOf":[{"type":"string"},{"type":"null"}]},"online_label":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","starts_at","ends_at","time_zone","venue","online_label"]}},"refunds":{"type":"object","properties":{"pending":{"type":"number"},"failed":{"type":"number"},"manual":{"type":"number"},"refunded":{"type":"number"}},"required":["pending","failed","manual","refunded"]}},"required":["product_id","canceled_at","subscriptions","finished_at","removed","refunds"]},{"type":"null"}]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/event_refunds":{"get":{"operationId":"listEventRefunds","summary":"Pages a canceled event's refunds: what each gives back, where it stands, and why one failed.","tags":["transaction"],"security":[{"bearer":["transaction:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["created"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"facets","in":"query","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["status"]}}}],"responses":{"200":{"description":"Pages a canceled event's refunds: what each gives back, where it stands, and why one failed.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"customer_id":{"type":"string"},"order_id":{"type":"string"},"settlement_id":{"type":"string"},"status":{"description":"`pending` while owed, `refunded` once given back, `failed` for the seller to retry, `manual` for a sale paid outside the store, which the seller refunds.","type":"string","x-extensible-enum":["pending","failed","manual","refunded"]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"failure":{"description":"Why the last try failed: `processor_refused`, `account_gone`, `processor_failed`, `processor_unavailable`, `nothing_left` or `order_unreconciled`; null unless failed.","anyOf":[{"type":"string"},{"type":"null"}]},"refund_id":{"description":"The refund recorded on the order once it landed.","anyOf":[{"type":"string"},{"type":"null"}]},"processor_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"refunded_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string"},"customer":{"description":"Who it gives back to, `erased` once their details are wiped.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]}},"required":["id","product_id","customer_id","order_id","settlement_id","status","amount","currency","exponent","failure","refund_id","processor_ref","refunded_at","created_at","customer"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/event_refunds/{refund}/retry":{"post":{"operationId":"retryEventRefund","summary":"Tries a canceled event's failed refund again.","tags":["transaction"],"security":[{"bearer":["transaction:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"refund","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Tries a canceled event's failed refund again.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"customer_id":{"type":"string"},"order_id":{"type":"string"},"settlement_id":{"type":"string"},"status":{"description":"`pending` while owed, `refunded` once given back, `failed` for the seller to retry, `manual` for a sale paid outside the store, which the seller refunds.","type":"string","x-extensible-enum":["pending","failed","manual","refunded"]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"failure":{"description":"Why the last try failed: `processor_refused`, `account_gone`, `processor_failed`, `processor_unavailable`, `nothing_left` or `order_unreconciled`; null unless failed.","anyOf":[{"type":"string"},{"type":"null"}]},"refund_id":{"description":"The refund recorded on the order once it landed.","anyOf":[{"type":"string"},{"type":"null"}]},"processor_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"refunded_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string"},"customer":{"description":"Who it gives back to, `erased` once their details are wiped.","anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]}},"required":["id","product_id","customer_id","order_id","settlement_id","status","amount","currency","exponent","failure","refund_id","processor_ref","refunded_at","created_at","customer"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}}}},"/v1/stores/{store}":{"get":{"operationId":"getStore","summary":"Reads the store: its name, hostname, subdomain, branding and plan.","tags":["site"],"security":[{"bearer":["site:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Reads the store: its name, hostname, subdomain, branding and plan.","content":{"application/json":{"schema":{"type":"object","properties":{"site":{"type":"object","properties":{"plan":{"type":"string","x-extensible-enum":["none","lite","pro","enterprise"]},"limits":{"description":"What the plan alone applies; `store_limits` is the store's own.","anyOf":[{"type":"object","properties":{"pages":{"type":"number","const":0},"menu":{"type":"number","const":0},"internal":{"type":"number","const":0},"external":{"type":"number","const":0},"stylesheet":{"type":"boolean","const":false},"unbranded":{"type":"boolean","const":false}},"required":["pages","menu","internal","external","stylesheet","unbranded"]},{"type":"object","properties":{"pages":{"type":"number","const":0},"menu":{"type":"number","const":4},"internal":{"type":"number","const":25},"external":{"type":"number","const":25},"stylesheet":{"type":"boolean","const":false},"unbranded":{"type":"boolean","const":false}},"required":["pages","menu","internal","external","stylesheet","unbranded"]},{"type":"object","properties":{"pages":{"type":"number","const":30},"menu":{"type":"number","const":4},"internal":{"type":"number","const":100},"external":{"type":"number","const":25},"stylesheet":{"type":"boolean","const":true},"unbranded":{"type":"boolean","const":true}},"required":["pages","menu","internal","external","stylesheet","unbranded"]},{"type":"object","properties":{"pages":{"type":"number","const":30},"menu":{"type":"number","const":4},"internal":{"type":"number","const":100},"external":{"type":"number","const":25},"stylesheet":{"type":"boolean","const":true},"unbranded":{"type":"boolean","const":true}},"required":["pages","menu","internal","external","stylesheet","unbranded"]}]},"store_limits":{"description":"How many of each the store's website applies and what it turns on, staff's raises counted; `room` is what it may hold.","type":"object","properties":{"pages":{"type":"number"},"menu":{"type":"number"},"internal":{"type":"number"},"external":{"type":"number"},"stylesheet":{"type":"boolean"},"unbranded":{"type":"boolean"}},"required":["pages","menu","internal","external","stylesheet","unbranded"]},"applies":{"description":"How many of each the store applies now, as its business last told it, else as its limits set.","type":"object","properties":{"pages":{"type":"number"},"menu":{"type":"number"},"internal":{"type":"number"},"external":{"type":"number"}},"required":["pages","menu","internal","external"]},"room":{"type":"object","properties":{"pages":{"type":"number"},"menu":{"type":"number"},"internal":{"type":"number"},"external":{"type":"number"}},"required":["pages","menu","internal","external"]},"used":{"type":"object","properties":{"pages":{"type":"number"},"menu":{"type":"number"},"internal":{"type":"number"},"external":{"type":"number"}},"required":["pages","menu","internal","external"]}},"required":["plan","limits","store_limits","applies","room","used"]},"plan":{"type":"object","properties":{"tier":{"type":"string","x-extensible-enum":["none","lite","pro","enterprise"]},"features":{"type":"object","properties":{"domain":{"type":"boolean"},"learning":{"type":"boolean"},"api":{"type":"boolean"},"self_hosted":{"type":"boolean"},"ai":{"type":"boolean"}},"required":["domain","learning","api","self_hosted","ai"]},"marketing_emails":{"description":"The plan's own; `store_marketing_emails` is what the store holds.","anyOf":[{"type":"number","const":0},{"type":"number","const":50000},{"type":"number","const":100000}]},"customers":{"description":"Against the plan's own cap; `store_customers` is against the store's.","anyOf":[{"type":"object","properties":{"used":{"type":"number"},"limit":{"anyOf":[{"type":"number","const":0},{"type":"number","const":2500}]},"standing":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","x-extensible-enum":["paused","ok","near"]},"pause_at":{"type":"null"}},"required":["status","pause_at"]},{"type":"object","properties":{"status":{"type":"string","const":"counting_down"},"pause_at":{"type":"string"}},"required":["status","pause_at"]},{"type":"null"}]}},"required":["used","limit","standing"]},{"type":"null"}]},"store_marketing_emails":{"description":"Marketing emails the store may send a month, staff's raises counted; null is not metered.","anyOf":[{"type":"number"},{"type":"null"}]},"store_customers":{"description":"The store's customers against its own cap, staff's raises counted; null without one.","anyOf":[{"type":"object","properties":{"used":{"type":"number"},"limit":{"type":"number"},"standing":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","x-extensible-enum":["paused","ok","near"]},"pause_at":{"type":"null"}},"required":["status","pause_at"]},{"type":"object","properties":{"status":{"type":"string","const":"counting_down"},"pause_at":{"type":"string"}},"required":["status","pause_at"]},{"type":"null"}]}},"required":["used","limit","standing"]},{"type":"null"}]},"standing":{"anyOf":[{"type":"object","properties":{"phase":{"type":"string","x-extensible-enum":["suspended","ok","notice","unlocks_paused","deleted"]},"trigger":{"anyOf":[{"type":"string","x-extensible-enum":["over_limit","plan_cancelled","payment_failed","plan_ended","no_plan"]},{"type":"null"}]},"over":{"type":"array","items":{"type":"string","x-extensible-enum":["customers","storage","members","stores"]}},"near":{"type":"array","items":{"type":"string","x-extensible-enum":["customers","storage"]}},"since":{"anyOf":[{"type":"string"},{"type":"null"}]},"unlocks_pause_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"suspend_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"delete_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"hold_until":{"anyOf":[{"type":"string"},{"type":"null"}]},"upgrade_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["phase","trigger","over","near","since","unlocks_pause_at","suspend_at","delete_at","hold_until","upgrade_at"]},{"type":"null"}]}},"required":["tier","features","marketing_emails","customers","store_marketing_emails","store_customers","standing"]},"files":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["video","audio","image","pdf","file"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes, null when it has none or is withheld.","anyOf":[{"type":"number"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"description":"Seconds.","anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"url":{"description":"A public file's lasting URL, an image's naming its widths' version as `#v=` once they're made; null for a private one, or one whose bytes haven't landed.","anyOf":[{"type":"string"},{"type":"null"}]},"resized":{"description":"A public image's smaller copies, narrowest first, for a `srcset`; left out until they're made and its width measured, for one kept as uploaded, and for any other file.","type":"array","items":{"type":"object","properties":{"width":{"description":"Its width in pixels, at most the image's own.","type":"integer","minimum":1},"avif":{"description":"A lasting URL to it as AVIF.","type":"string"},"webp":{"description":"A lasting URL to it as WebP.","type":"string"}},"required":["width","avif","webp"]}},"attachment_id":{"description":"The binding a private file opens through; null when the reader can't open it.","anyOf":[{"type":"string"},{"type":"null"}]},"unlocks":{"description":"What unlocks a file its own rules keep from the reader, any one; null for any other file.","anyOf":[{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product_name":{"type":"string"},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]}},"required":["product_id","product_name","tier"]}},{"type":"null"}]},"video":{"description":"A video's subtitles and published AI outputs, where its read lists any and the reader may play it.","type":"object","properties":{"attachment_id":{"type":"string"},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["attachment_id","tracks","outputs"]},"audio":{"description":"An audio file's waveform, subtitles and published AI outputs, where the reader may play it.","type":"object","properties":{"waveform":{"description":"256 levels from 0 to 255, base64, from the file's start to its end; null until drawn, or when it can't be.","anyOf":[{"type":"string"},{"type":"null"}]},"attachment_id":{"description":"The binding its tracks and outputs open through, which a public file carries here alone; null with none.","anyOf":[{"type":"string"},{"type":"null"}]},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["waveform","attachment_id","tracks","outputs"]}},"required":["id","kind","mime","name","bytes","width","height","duration","pages","status","url","attachment_id","unlocks"]}},"integrations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"kind":{"type":"string"},"sets_cookies":{"type":"boolean"},"enabled":{"type":"boolean"},"connection_ended_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"config_schema":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"secret_set":{"type":"object","properties":{},"additionalProperties":{"type":"boolean"}}},"required":["id","name","description","kind","sets_cookies","enabled","connection_ended_at","config_schema","secret_set"]}},"redirects":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"from_path":{"type":"string"},"to_path":{"type":"string"},"status":{"type":"number"},"enabled":{"type":"boolean"},"live":{"description":"Resolved: enabled and within the redirects of its kind the plan applies.","type":"boolean"},"connection_ended_at":{"description":"When it was turned off because the connection that set it up ended.","anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","from_path","to_path","status","enabled","live","connection_ended_at","created_at"]}},"total":{"type":"number"}},"required":["items","total"]},"notifications":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"event":{"type":"string"},"target":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry"]},"id":{"type":"string"}},"required":["kind","id"]},{"type":"null"}]},"locale":{"type":"string"},"channel":{"type":"string","x-extensible-enum":["email"]},"enabled":{"type":"boolean"},"in_effect":{"type":"boolean"}},"required":["id","event","target","locale","channel","enabled","in_effect"]}},"total":{"type":"number"}},"required":["items","total"]},"work":{"type":"object","properties":{"pending":{"type":"number"},"parked":{"type":"number"}},"required":["pending","parked"]},"locale":{"type":"string"},"tint":{"anyOf":[{"type":"string"},{"type":"null"}]},"tint_dark":{"anyOf":[{"type":"string"},{"type":"null"}]},"delivery_ttl_seconds":{"type":"number"},"refund_revokes_access":{"type":"boolean"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"time_zone":{"type":"string"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"storefront":{"type":"object","properties":{"external_site":{"description":"The seller's own site, linked from the header.","type":"string","minLength":1,"maxLength":2000},"socials":{"description":"Profile URLs on the networks the footer shows (Instagram, X, YouTube, LinkedIn, TikTok, Twitch, Threads, GitHub, Facebook, Discord, Telegram, Reddit, Bluesky, Slack, and Mastodon on mastodon.social, mastodon.online, fosstodon.org, hachyderm.io, infosec.exchange, techhub.social or a host with a `mastodon` or `mstdn` label), linked from the footer.","type":"array","items":{"type":"string","minLength":1,"maxLength":2000},"maxItems":20},"theme":{"description":"The schemes visitors may pick; absent offers both.","type":"string","x-extensible-enum":["both","light","dark"]},"no_index":{"type":"boolean"},"powered_by":{"type":"boolean"},"animated_background":{"description":"The dots drifting behind the hero.","type":"boolean"},"header_hidden":{"description":"Whether the site's header and footer are left off its pages.","type":"boolean"},"footer_hidden":{"type":"boolean"}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"revision":{"type":"number"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"id":{"type":"string"},"name":{"type":"string"},"merchant_id":{"type":"string"},"hostname":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The store home's absolute URL on its verified hostname, or null before it has one.","anyOf":[{"type":"string"},{"type":"null"}]},"subdomain":{"anyOf":[{"type":"string"},{"type":"null"}]},"hostnames":{"type":"array","items":{"type":"string"}},"swatch":{"anyOf":[{"type":"string","x-extensible-enum":["emerald","blue","teal","indigo","purple","pink","red","orange","yellow","gray"]},{"type":"null"}]},"icon":{"type":"string"}},"required":["site","plan","files","integrations","redirects","notifications","work","locale","tint","tint_dark","delivery_ttl_seconds","refund_revokes_access","description","time_zone","currency","settings","metadata","revision","updated_at","id","name","merchant_id","hostname","url","subdomain","hostnames","swatch","icon"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"patch":{"operationId":"updateStore","summary":"Updates the store's name, description and branding.","tags":["site"],"security":[{"bearer":["site:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Updates the store's name, description and branding.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"locale":{"type":"string"},"location":{"anyOf":[{"type":"string","x-extensible-enum":["wnam","enam","sam","weur","eeur","apac","apac-ne","apac-se","oc","afr","me"]},{"type":"null"}]},"hostname":{"anyOf":[{"type":"string"},{"type":"null"}]},"swatch":{"anyOf":[{"type":"string","x-extensible-enum":["emerald","blue","teal","indigo","purple","pink","red","orange","yellow","gray"]},{"type":"null"}]},"icon":{"type":"string"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","locale","location","hostname","swatch","icon","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"Stored trimmed; a blank one is refused.","type":"string","minLength":1,"maxLength":120},"swatch":{"anyOf":[{"type":"string","enum":["emerald","blue","teal","indigo","purple","pink","red","orange","yellow","gray"]},{"type":"null"}]}},"additionalProperties":false}}}}}},"/v1/stores/{store}/settings":{"get":{"operationId":"getSettings","summary":"Reads the store's settings.","tags":["site"],"security":[{"bearer":["site:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Reads the store's settings.","content":{"application/json":{"schema":{"type":"object","properties":{"hostnames":{"type":"array","items":{"type":"string"}},"locale":{"type":"string"},"tint":{"anyOf":[{"type":"string"},{"type":"null"}]},"tint_dark":{"anyOf":[{"type":"string"},{"type":"null"}]},"delivery_ttl_seconds":{"type":"number"},"refund_revokes_access":{"type":"boolean"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"time_zone":{"type":"string"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"storefront":{"type":"object","properties":{"external_site":{"description":"The seller's own site, linked from the header.","type":"string","minLength":1,"maxLength":2000},"socials":{"description":"Profile URLs on the networks the footer shows (Instagram, X, YouTube, LinkedIn, TikTok, Twitch, Threads, GitHub, Facebook, Discord, Telegram, Reddit, Bluesky, Slack, and Mastodon on mastodon.social, mastodon.online, fosstodon.org, hachyderm.io, infosec.exchange, techhub.social or a host with a `mastodon` or `mstdn` label), linked from the footer.","type":"array","items":{"type":"string","minLength":1,"maxLength":2000},"maxItems":20},"theme":{"description":"The schemes visitors may pick; absent offers both.","type":"string","x-extensible-enum":["both","light","dark"]},"no_index":{"type":"boolean"},"powered_by":{"type":"boolean"},"animated_background":{"description":"The dots drifting behind the hero.","type":"boolean"},"header_hidden":{"description":"Whether the site's header and footer are left off its pages.","type":"boolean"},"footer_hidden":{"type":"boolean"}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"revision":{"type":"number"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["hostnames","locale","tint","tint_dark","delivery_ttl_seconds","refund_revokes_access","description","time_zone","currency","settings","metadata","revision","updated_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"patch":{"operationId":"updateSettings","summary":"Updates the store's settings.","tags":["site"],"security":[{"bearer":["site:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Updates the store's settings.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"site":{"type":"object","properties":{"plan":{"type":"string","x-extensible-enum":["none","lite","pro","enterprise"]},"limits":{"description":"What the plan alone applies; `store_limits` is the store's own.","anyOf":[{"type":"object","properties":{"pages":{"type":"number","const":0},"menu":{"type":"number","const":0},"internal":{"type":"number","const":0},"external":{"type":"number","const":0},"stylesheet":{"type":"boolean","const":false},"unbranded":{"type":"boolean","const":false}},"required":["pages","menu","internal","external","stylesheet","unbranded"]},{"type":"object","properties":{"pages":{"type":"number","const":0},"menu":{"type":"number","const":4},"internal":{"type":"number","const":25},"external":{"type":"number","const":25},"stylesheet":{"type":"boolean","const":false},"unbranded":{"type":"boolean","const":false}},"required":["pages","menu","internal","external","stylesheet","unbranded"]},{"type":"object","properties":{"pages":{"type":"number","const":30},"menu":{"type":"number","const":4},"internal":{"type":"number","const":100},"external":{"type":"number","const":25},"stylesheet":{"type":"boolean","const":true},"unbranded":{"type":"boolean","const":true}},"required":["pages","menu","internal","external","stylesheet","unbranded"]},{"type":"object","properties":{"pages":{"type":"number","const":30},"menu":{"type":"number","const":4},"internal":{"type":"number","const":100},"external":{"type":"number","const":25},"stylesheet":{"type":"boolean","const":true},"unbranded":{"type":"boolean","const":true}},"required":["pages","menu","internal","external","stylesheet","unbranded"]}]},"store_limits":{"description":"How many of each the store's website applies and what it turns on, staff's raises counted; `room` is what it may hold.","type":"object","properties":{"pages":{"type":"number"},"menu":{"type":"number"},"internal":{"type":"number"},"external":{"type":"number"},"stylesheet":{"type":"boolean"},"unbranded":{"type":"boolean"}},"required":["pages","menu","internal","external","stylesheet","unbranded"]},"applies":{"description":"How many of each the store applies now, as its business last told it, else as its limits set.","type":"object","properties":{"pages":{"type":"number"},"menu":{"type":"number"},"internal":{"type":"number"},"external":{"type":"number"}},"required":["pages","menu","internal","external"]},"room":{"type":"object","properties":{"pages":{"type":"number"},"menu":{"type":"number"},"internal":{"type":"number"},"external":{"type":"number"}},"required":["pages","menu","internal","external"]},"used":{"type":"object","properties":{"pages":{"type":"number"},"menu":{"type":"number"},"internal":{"type":"number"},"external":{"type":"number"}},"required":["pages","menu","internal","external"]}},"required":["plan","limits","store_limits","applies","room","used"]},"plan":{"type":"object","properties":{"tier":{"type":"string","x-extensible-enum":["none","lite","pro","enterprise"]},"features":{"type":"object","properties":{"domain":{"type":"boolean"},"learning":{"type":"boolean"},"api":{"type":"boolean"},"self_hosted":{"type":"boolean"},"ai":{"type":"boolean"}},"required":["domain","learning","api","self_hosted","ai"]},"marketing_emails":{"description":"The plan's own; `store_marketing_emails` is what the store holds.","anyOf":[{"type":"number","const":0},{"type":"number","const":50000},{"type":"number","const":100000}]},"customers":{"description":"Against the plan's own cap; `store_customers` is against the store's.","anyOf":[{"type":"object","properties":{"used":{"type":"number"},"limit":{"anyOf":[{"type":"number","const":0},{"type":"number","const":2500}]},"standing":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","x-extensible-enum":["paused","ok","near"]},"pause_at":{"type":"null"}},"required":["status","pause_at"]},{"type":"object","properties":{"status":{"type":"string","const":"counting_down"},"pause_at":{"type":"string"}},"required":["status","pause_at"]},{"type":"null"}]}},"required":["used","limit","standing"]},{"type":"null"}]},"store_marketing_emails":{"description":"Marketing emails the store may send a month, staff's raises counted; null is not metered.","anyOf":[{"type":"number"},{"type":"null"}]},"store_customers":{"description":"The store's customers against its own cap, staff's raises counted; null without one.","anyOf":[{"type":"object","properties":{"used":{"type":"number"},"limit":{"type":"number"},"standing":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","x-extensible-enum":["paused","ok","near"]},"pause_at":{"type":"null"}},"required":["status","pause_at"]},{"type":"object","properties":{"status":{"type":"string","const":"counting_down"},"pause_at":{"type":"string"}},"required":["status","pause_at"]},{"type":"null"}]}},"required":["used","limit","standing"]},{"type":"null"}]},"standing":{"anyOf":[{"type":"object","properties":{"phase":{"type":"string","x-extensible-enum":["suspended","ok","notice","unlocks_paused","deleted"]},"trigger":{"anyOf":[{"type":"string","x-extensible-enum":["over_limit","plan_cancelled","payment_failed","plan_ended","no_plan"]},{"type":"null"}]},"over":{"type":"array","items":{"type":"string","x-extensible-enum":["customers","storage","members","stores"]}},"near":{"type":"array","items":{"type":"string","x-extensible-enum":["customers","storage"]}},"since":{"anyOf":[{"type":"string"},{"type":"null"}]},"unlocks_pause_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"suspend_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"delete_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"hold_until":{"anyOf":[{"type":"string"},{"type":"null"}]},"upgrade_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["phase","trigger","over","near","since","unlocks_pause_at","suspend_at","delete_at","hold_until","upgrade_at"]},{"type":"null"}]}},"required":["tier","features","marketing_emails","customers","store_marketing_emails","store_customers","standing"]},"files":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","x-extensible-enum":["video","audio","image","pdf","file"]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"description":"The file's size in bytes, null when it has none or is withheld.","anyOf":[{"type":"number"},{"type":"null"}]},"width":{"anyOf":[{"type":"number"},{"type":"null"}]},"height":{"anyOf":[{"type":"number"},{"type":"null"}]},"duration":{"description":"Seconds.","anyOf":[{"type":"number"},{"type":"null"}]},"pages":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["pending","ready","failed"]},"url":{"description":"A public file's lasting URL, an image's naming its widths' version as `#v=` once they're made; null for a private one, or one whose bytes haven't landed.","anyOf":[{"type":"string"},{"type":"null"}]},"resized":{"description":"A public image's smaller copies, narrowest first, for a `srcset`; left out until they're made and its width measured, for one kept as uploaded, and for any other file.","type":"array","items":{"type":"object","properties":{"width":{"description":"Its width in pixels, at most the image's own.","type":"integer","minimum":1},"avif":{"description":"A lasting URL to it as AVIF.","type":"string"},"webp":{"description":"A lasting URL to it as WebP.","type":"string"}},"required":["width","avif","webp"]}},"attachment_id":{"description":"The binding a private file opens through; null when the reader can't open it.","anyOf":[{"type":"string"},{"type":"null"}]},"unlocks":{"description":"What unlocks a file its own rules keep from the reader, any one; null for any other file.","anyOf":[{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product_name":{"type":"string"},"tier":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"rank":{"type":"number"}},"required":["id","name","rank"]},{"type":"null"}]}},"required":["product_id","product_name","tier"]}},{"type":"null"}]},"video":{"description":"A video's subtitles and published AI outputs, where its read lists any and the reader may play it.","type":"object","properties":{"attachment_id":{"type":"string"},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["attachment_id","tracks","outputs"]},"audio":{"description":"An audio file's waveform, subtitles and published AI outputs, where the reader may play it.","type":"object","properties":{"waveform":{"description":"256 levels from 0 to 255, base64, from the file's start to its end; null until drawn, or when it can't be.","anyOf":[{"type":"string"},{"type":"null"}]},"attachment_id":{"description":"The binding its tracks and outputs open through, which a public file carries here alone; null with none.","anyOf":[{"type":"string"},{"type":"null"}]},"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"generated":{"description":"Subtitles the store generated with AI from the file's audio.","type":"boolean"}},"required":["id","label","language","generated"]}},"outputs":{"description":"The published AI outputs `getMediaOutputs` reads.","type":"array","items":{"type":"string","x-extensible-enum":["summary","chapters","transcript"]}}},"required":["waveform","attachment_id","tracks","outputs"]}},"required":["id","kind","mime","name","bytes","width","height","duration","pages","status","url","attachment_id","unlocks"]}},"integrations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"kind":{"type":"string"},"sets_cookies":{"type":"boolean"},"enabled":{"type":"boolean"},"connection_ended_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"config_schema":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"secret_set":{"type":"object","properties":{},"additionalProperties":{"type":"boolean"}}},"required":["id","name","description","kind","sets_cookies","enabled","connection_ended_at","config_schema","secret_set"]}},"redirects":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"from_path":{"type":"string"},"to_path":{"type":"string"},"status":{"type":"number"},"enabled":{"type":"boolean"},"live":{"description":"Resolved: enabled and within the redirects of its kind the plan applies.","type":"boolean"},"connection_ended_at":{"description":"When it was turned off because the connection that set it up ended.","anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","from_path","to_path","status","enabled","live","connection_ended_at","created_at"]}},"total":{"type":"number"}},"required":["items","total"]},"notifications":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"event":{"type":"string"},"target":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry"]},"id":{"type":"string"}},"required":["kind","id"]},{"type":"null"}]},"locale":{"type":"string"},"channel":{"type":"string","x-extensible-enum":["email"]},"enabled":{"type":"boolean"},"in_effect":{"type":"boolean"}},"required":["id","event","target","locale","channel","enabled","in_effect"]}},"total":{"type":"number"}},"required":["items","total"]},"work":{"type":"object","properties":{"pending":{"type":"number"},"parked":{"type":"number"}},"required":["pending","parked"]},"locale":{"type":"string"},"tint":{"anyOf":[{"type":"string"},{"type":"null"}]},"tint_dark":{"anyOf":[{"type":"string"},{"type":"null"}]},"delivery_ttl_seconds":{"type":"number"},"refund_revokes_access":{"type":"boolean"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"time_zone":{"type":"string"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"settings":{"type":"object","properties":{"storefront":{"type":"object","properties":{"external_site":{"description":"The seller's own site, linked from the header.","type":"string","minLength":1,"maxLength":2000},"socials":{"description":"Profile URLs on the networks the footer shows (Instagram, X, YouTube, LinkedIn, TikTok, Twitch, Threads, GitHub, Facebook, Discord, Telegram, Reddit, Bluesky, Slack, and Mastodon on mastodon.social, mastodon.online, fosstodon.org, hachyderm.io, infosec.exchange, techhub.social or a host with a `mastodon` or `mstdn` label), linked from the footer.","type":"array","items":{"type":"string","minLength":1,"maxLength":2000},"maxItems":20},"theme":{"description":"The schemes visitors may pick; absent offers both.","type":"string","x-extensible-enum":["both","light","dark"]},"no_index":{"type":"boolean"},"powered_by":{"type":"boolean"},"animated_background":{"description":"The dots drifting behind the hero.","type":"boolean"},"header_hidden":{"description":"Whether the site's header and footer are left off its pages.","type":"boolean"},"footer_hidden":{"type":"boolean"}}}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"revision":{"type":"number"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"id":{"type":"string"},"name":{"type":"string"},"merchant_id":{"type":"string"},"hostname":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The store home's absolute URL on its verified hostname, or null before it has one.","anyOf":[{"type":"string"},{"type":"null"}]},"subdomain":{"anyOf":[{"type":"string"},{"type":"null"}]},"hostnames":{"type":"array","items":{"type":"string"}},"swatch":{"anyOf":[{"type":"string","x-extensible-enum":["emerald","blue","teal","indigo","purple","pink","red","orange","yellow","gray"]},{"type":"null"}]},"icon":{"type":"string"}},"required":["site","plan","files","integrations","redirects","notifications","work","locale","tint","tint_dark","delivery_ttl_seconds","refund_revokes_access","description","time_zone","currency","settings","metadata","revision","updated_at","id","name","merchant_id","hostname","url","subdomain","hostnames","swatch","icon"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"locale":{"type":"string","minLength":1,"maxLength":5,"pattern":"^[a-z]{2}(?:-[A-Z]{2})?$"},"tint":{"anyOf":[{"type":"string","minLength":1,"maxLength":7,"pattern":"^#[0-9a-fA-F]{6}$"},{"type":"null"}]},"tint_dark":{"anyOf":[{"type":"string","minLength":1,"maxLength":7,"pattern":"^#[0-9a-fA-F]{6}$"},{"type":"null"}]},"delivery_ttl_seconds":{"type":"integer","minimum":60,"maximum":604800},"refund_revokes_access":{"type":"boolean"},"description":{"anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]},"time_zone":{"type":"string","minLength":1,"maxLength":64},"currency":{"description":"The currency the store reports in; null clears it.","anyOf":[{"type":"string","minLength":3,"maxLength":3},{"type":"null"}]},"settings":{"description":"Merged onto the stored settings; null deletes a key.","type":"object","properties":{"storefront":{"anyOf":[{"type":"object","properties":{"external_site":{"description":"The seller's own site, linked from the header.","anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]},"socials":{"description":"Profile URLs on the networks the footer shows (Instagram, X, YouTube, LinkedIn, TikTok, Twitch, Threads, GitHub, Facebook, Discord, Telegram, Reddit, Bluesky, Slack, and Mastodon on mastodon.social, mastodon.online, fosstodon.org, hachyderm.io, infosec.exchange, techhub.social or a host with a `mastodon` or `mstdn` label), linked from the footer.","anyOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":2000},"maxItems":20},{"type":"null"}]},"theme":{"description":"The schemes visitors may pick; absent offers both.","anyOf":[{"type":"string","enum":["both","light","dark"]},{"type":"null"}]},"no_index":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"powered_by":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"animated_background":{"description":"The dots drifting behind the hero.","anyOf":[{"type":"boolean"},{"type":"null"}]},"header_hidden":{"description":"Whether the site's header and footer are left off its pages.","anyOf":[{"type":"boolean"},{"type":"null"}]},"footer_hidden":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"from":{"description":"The revision the caller read; a write made since refuses.","type":"object","properties":{"revision":{"type":"integer","minimum":0}},"required":["revision"],"additionalProperties":false}},"additionalProperties":false}}}}}},"/v1/stores/{store}/plan_usage":{"get":{"operationId":"getPlanUsage","summary":"Reads the store's plan, with the day it ends when set to cancel and whether it can still be resumed, and the plan billed once its period ends (a scheduled change up or down, or the base plan a cancelled one lapses into), and every limit it sets each store, with what the store uses of it: storage, transcription minutes, customers (with where the countdown past the cap stands), pages, menu items and redirects (with how many are kept inactive past what the store applies), features, the add-on blocks of storage and AI media minutes the store holds, where the business stands against its plan, what keeps it from moving to Lite and the plan change last called off for it (over its limits, or a move to the plan it holds for good or under it), and the marketing emails it may send a month, whose use is not reported yet.","tags":["site"],"security":[{"bearer":["site:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Reads the store's plan, with the day it ends when set to cancel and whether it can still be resumed, and the plan billed once its period ends (a scheduled change up or down, or the base plan a cancelled one lapses into), and every limit it sets each store, with what the store uses of it: storage, transcription minutes, customers (with where the countdown past the cap stands), pages, menu items and redirects (with how many are kept inactive past what the store applies), features, the add-on blocks of storage and AI media minutes the store holds, where the business stands against its plan, what keeps it from moving to Lite and the plan change last called off for it (over its limits, or a move to the plan it holds for good or under it), and the marketing emails it may send a month, whose use is not reported yet.","content":{"application/json":{"schema":{"type":"object","properties":{"plan":{"anyOf":[{"type":"object","properties":{"key":{"type":"string"},"tier":{"type":"string","x-extensible-enum":["none","lite","pro","enterprise"]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"resumable":{"type":"boolean"},"scheduled":{"anyOf":[{"type":"object","properties":{"key":{"type":"string"},"tier":{"type":"string","x-extensible-enum":["none","lite","pro","enterprise"]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"at":{"type":"string"}},"required":["key","tier","name","at"]},{"type":"null"}]}},"required":["key","tier","name","ends_at","resumable","scheduled"]},{"type":"null"}]},"metered":{"type":"object","properties":{"storage":{"type":"object","properties":{"used_bytes":{"description":"The files' size in bytes, as they count against the store's storage.","type":"number"},"allowance_bytes":{"type":"number"}},"required":["used_bytes","allowance_bytes"]},"transcription":{"type":"object","properties":{"used_minutes":{"type":"number"},"allowance_minutes":{"type":"number"},"renews_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["used_minutes","allowance_minutes","renews_at"]},"marketing_emails":{"type":"object","properties":{"used":{"anyOf":[{"type":"number"},{"type":"null"}]},"allowance":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["used","allowance"]}},"required":["storage","transcription","marketing_emails"]},"add_ons":{"type":"object","properties":{"storage":{"type":"number"},"minutes":{"type":"number"}},"required":["storage","minutes"]},"auto_upgrade":{"type":"boolean"},"within_lite":{"type":"boolean"},"over_lite":{"type":"array","items":{"type":"string","x-extensible-enum":["pages","customers","redirects","storage","members","stores"]}},"change_refusal":{"anyOf":[{"type":"object","properties":{"at":{"type":"string"},"over":{"type":"array","items":{"type":"string","x-extensible-enum":["pages","customers","redirects","storage","members","stores"]}},"unsure":{"type":"array","items":{"type":"string","x-extensible-enum":["pages","customers","redirects","storage","members","stores"]}},"base":{"anyOf":[{"type":"object","properties":{"key":{"type":"string"},"tier":{"type":"string","x-extensible-enum":["none","lite","pro","enterprise"]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["key","tier","name"]},{"type":"null"}]}},"required":["at","over","unsure","base"]},{"type":"null"}]},"standing":{"anyOf":[{"type":"object","properties":{"phase":{"type":"string","x-extensible-enum":["suspended","ok","notice","unlocks_paused","deleted"]},"trigger":{"anyOf":[{"type":"string","x-extensible-enum":["over_limit","plan_cancelled","payment_failed","plan_ended","no_plan"]},{"type":"null"}]},"over":{"type":"array","items":{"type":"string","x-extensible-enum":["customers","storage","members","stores"]}},"near":{"type":"array","items":{"type":"string","x-extensible-enum":["customers","storage"]}},"since":{"anyOf":[{"type":"string"},{"type":"null"}]},"unlocks_pause_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"suspend_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"delete_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"hold_until":{"anyOf":[{"type":"string"},{"type":"null"}]},"upgrade_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["phase","trigger","over","near","since","unlocks_pause_at","suspend_at","delete_at","hold_until","upgrade_at"]},{"type":"null"}]},"counts":{"type":"object","properties":{"customers":{"type":"object","properties":{"used":{"type":"number"},"limit":{"anyOf":[{"type":"number"},{"type":"null"}]},"standing":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","x-extensible-enum":["paused","ok","near"]},"pause_at":{"type":"null"}},"required":["status","pause_at"]},{"type":"object","properties":{"status":{"type":"string","const":"counting_down"},"pause_at":{"type":"string"}},"required":["status","pause_at"]},{"type":"null"}]}},"required":["used","limit","standing"]},"pages":{"type":"object","properties":{"used":{"type":"number"},"limit":{"type":"number"},"inactive":{"type":"number"}},"required":["used","limit","inactive"]},"menu":{"type":"object","properties":{"used":{"type":"number"},"limit":{"type":"number"},"inactive":{"type":"number"}},"required":["used","limit","inactive"]},"internal_redirects":{"type":"object","properties":{"used":{"type":"number"},"limit":{"type":"number"},"inactive":{"type":"number"}},"required":["used","limit","inactive"]},"external_redirects":{"type":"object","properties":{"used":{"type":"number"},"limit":{"type":"number"},"inactive":{"type":"number"}},"required":["used","limit","inactive"]}},"required":["customers","pages","menu","internal_redirects","external_redirects"]},"features":{"type":"object","properties":{"domain":{"type":"boolean"},"unbranded":{"type":"boolean"},"stylesheet":{"type":"boolean"},"learning":{"type":"boolean"},"self_hosted":{"type":"boolean"},"ai":{"type":"boolean"}},"required":["domain","unbranded","stylesheet","learning","self_hosted","ai"]}},"required":["plan","metered","add_ons","auto_upgrade","within_lite","over_lite","change_refusal","standing","counts","features"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/domain":{"get":{"operationId":"getDomain","summary":"Reads the store's own domain, if it has one: where it stands, the DNS records it needs, and whether the store's plan includes a domain.","tags":["site"],"security":[{"bearer":["site:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Reads the store's own domain, if it has one: where it stands, the DNS records it needs, and whether the store's plan includes a domain.","content":{"application/json":{"schema":{"type":"object","properties":{"included":{"type":"boolean"},"available":{"type":"boolean"},"target":{"anyOf":[{"type":"string"},{"type":"null"}]},"domain":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"hostname":{"type":"string"},"status":{"type":"string","x-extensible-enum":["pending","failed","active"]},"failure":{"anyOf":[{"type":"string","x-extensible-enum":["expired","certificate","moved","deleted","timed_out","blocked"]},{"type":"null"}]},"records":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","const":"CNAME"},"name":{"type":"string"},"value":{"type":"string"}},"required":["type","name","value"]},{"type":"object","properties":{"type":{"type":"string","const":"TXT"},"name":{"type":"string"},"value":{"type":"string"}},"required":["type","name","value"]}]}},"verified_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"checked_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string"}},"required":["id","hostname","status","failure","records","verified_at","checked_at","created_at"]},{"type":"null"}]}},"required":["included","available","target","domain"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/domain/connect":{"post":{"operationId":"connectDomain","summary":"Connects a domain the seller owns to the store, answering the DNS records to set; it becomes the store's main address once they check out, or at once when it already does. Needs a plan that includes a domain.","tags":["site"],"security":[{"bearer":["site:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Connects a domain the seller owns to the store, answering the DNS records to set; it becomes the store's main address once they check out, or at once when it already does. Needs a plan that includes a domain.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"included":{"type":"boolean"},"available":{"type":"boolean"},"target":{"anyOf":[{"type":"string"},{"type":"null"}]},"domain":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"hostname":{"type":"string"},"status":{"type":"string","x-extensible-enum":["pending","failed","active"]},"failure":{"anyOf":[{"type":"string","x-extensible-enum":["expired","certificate","moved","deleted","timed_out","blocked"]},{"type":"null"}]},"records":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","const":"CNAME"},"name":{"type":"string"},"value":{"type":"string"}},"required":["type","name","value"]},{"type":"object","properties":{"type":{"type":"string","const":"TXT"},"name":{"type":"string"},"value":{"type":"string"}},"required":["type","name","value"]}]}},"verified_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"checked_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string"}},"required":["id","hostname","status","failure","records","verified_at","checked_at","created_at"]},{"type":"null"}]}},"required":["included","available","target","domain"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"hostname":{"type":"string","minLength":3,"maxLength":253}},"required":["hostname"],"additionalProperties":false}}}}}},"/v1/stores/{store}/domain/check":{"post":{"operationId":"checkDomain","summary":"Checks the store's own domain at Cloudflare now, making it the store's main address once its records check out while the plan includes a domain; a check moments after another answers the domain as last read.","tags":["site"],"security":[{"bearer":["site:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Checks the store's own domain at Cloudflare now, making it the store's main address once its records check out while the plan includes a domain; a check moments after another answers the domain as last read.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"included":{"type":"boolean"},"available":{"type":"boolean"},"target":{"anyOf":[{"type":"string"},{"type":"null"}]},"domain":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"hostname":{"type":"string"},"status":{"type":"string","x-extensible-enum":["pending","failed","active"]},"failure":{"anyOf":[{"type":"string","x-extensible-enum":["expired","certificate","moved","deleted","timed_out","blocked"]},{"type":"null"}]},"records":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","const":"CNAME"},"name":{"type":"string"},"value":{"type":"string"}},"required":["type","name","value"]},{"type":"object","properties":{"type":{"type":"string","const":"TXT"},"name":{"type":"string"},"value":{"type":"string"}},"required":["type","name","value"]}]}},"verified_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"checked_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string"}},"required":["id","hostname","status","failure","records","verified_at","checked_at","created_at"]},{"type":"null"}]}},"required":["included","available","target","domain"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}}}},"/v1/stores/{store}/domain/remove":{"post":{"operationId":"removeDomain","summary":"Stops serving the store on its own domain, or dismisses one that was let go; its Sherpo address becomes its main address again. Answers not found when the store has no domain, as after a removal that already landed.","tags":["site"],"security":[{"bearer":["site:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Stops serving the store on its own domain, or dismisses one that was let go; its Sherpo address becomes its main address again. Answers not found when the store has no domain, as after a removal that already landed.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"included":{"type":"boolean"},"available":{"type":"boolean"},"target":{"anyOf":[{"type":"string"},{"type":"null"}]},"domain":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"hostname":{"type":"string"},"status":{"type":"string","x-extensible-enum":["pending","failed","active"]},"failure":{"anyOf":[{"type":"string","x-extensible-enum":["expired","certificate","moved","deleted","timed_out","blocked"]},{"type":"null"}]},"records":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","const":"CNAME"},"name":{"type":"string"},"value":{"type":"string"}},"required":["type","name","value"]},{"type":"object","properties":{"type":{"type":"string","const":"TXT"},"name":{"type":"string"},"value":{"type":"string"}},"required":["type","name","value"]}]}},"verified_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"checked_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string"}},"required":["id","hostname","status","failure","records","verified_at","checked_at","created_at"]},{"type":"null"}]}},"required":["included","available","target","domain"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}}}},"/v1/stores/{store}/icon":{"put":{"operationId":"setStoreIcon","summary":"Sets or clears the store's icon from a file.","tags":["site"],"security":[{"bearer":["site:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Sets or clears the store's icon from a file.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"locale":{"type":"string"},"location":{"anyOf":[{"type":"string","x-extensible-enum":["wnam","enam","sam","weur","eeur","apac","apac-ne","apac-se","oc","afr","me"]},{"type":"null"}]},"hostname":{"anyOf":[{"type":"string"},{"type":"null"}]},"swatch":{"anyOf":[{"type":"string","x-extensible-enum":["emerald","blue","teal","indigo","purple","pink","red","orange","yellow","gray"]},{"type":"null"}]},"icon":{"type":"string"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","locale","location","hostname","swatch","icon","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"image":{"anyOf":[{"type":"string","contentEncoding":"base64"},{"type":"string","contentEncoding":"base64"}]}},"required":["image"],"additionalProperties":false}}}}}},"/v1/stores/{store}/organization":{"get":{"operationId":"getOrganization","summary":"Reads the store's business.","tags":["organization"],"security":[{"bearer":["organization:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Reads the store's business.","content":{"application/json":{"schema":{"type":"object","properties":{"plan":{"anyOf":[{"type":"object","properties":{"plan":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier":{"type":"string","x-extensible-enum":["none","lite","pro","enterprise"]},"price_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"interval":{"anyOf":[{"type":"string","x-extensible-enum":["month","year"]},{"type":"null"}]},"quantity":{"type":"number"},"scheduled_quantity":{"anyOf":[{"type":"number"},{"type":"null"}]},"scheduled_plan":{"anyOf":[{"type":"string"},{"type":"null"}]},"scheduled_price_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"scheduled_interval":{"anyOf":[{"type":"string","x-extensible-enum":["month","year"]},{"type":"null"}]},"scheduled_releases":{"type":"number"},"scheduled_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"pending_switch":{"anyOf":[{"type":"object","properties":{"plan":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"interval":{"anyOf":[{"type":"string","x-extensible-enum":["month","year"]},{"type":"null"}]}},"required":["plan","name","interval"]},{"type":"null"}]},"storage_bytes":{"anyOf":[{"type":"number"},{"type":"null"}]},"member_limit":{"anyOf":[{"type":"number"},{"type":"null"}]},"transcription_minutes":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["active","past_due","cancelled"]},"valid_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"valid_until":{"anyOf":[{"type":"string"},{"type":"null"}]},"cancelled_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"trial_ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"source_kind":{"type":"string","x-extensible-enum":["checkout","manual","staff"]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["plan","name","tier","price_ref","interval","quantity","scheduled_quantity","scheduled_plan","scheduled_price_ref","scheduled_interval","scheduled_releases","scheduled_at","pending_switch","storage_bytes","member_limit","transcription_minutes","status","valid_from","valid_until","cancelled_at","trial_ends_at","source_kind","updated_at"]},{"type":"null"}]},"base_plan":{"description":"The plan held for good beneath any bought, whether or not one is live; null for none.","anyOf":[{"type":"object","properties":{"plan":{"description":"The plan's key: a tier, or a product of no tier.","type":"string"},"name":{"description":"Null for a plan of no name of ours.","anyOf":[{"type":"string"},{"type":"null"}]},"tier":{"description":"Whose limits apply.","type":"string","x-extensible-enum":["none","lite","pro","enterprise"]},"granted_at":{"description":"When Sherpo granted it.","type":"string","format":"date-time"},"in_effect":{"description":"Whether it is the plan answered, as no bought plan is live.","type":"boolean"}},"required":["plan","name","tier","granted_at","in_effect"]},{"type":"null"}]},"standing":{"anyOf":[{"type":"object","properties":{"phase":{"type":"string","x-extensible-enum":["suspended","ok","notice","unlocks_paused","deleted"]},"trigger":{"anyOf":[{"type":"string","x-extensible-enum":["over_limit","plan_cancelled","payment_failed","plan_ended","no_plan"]},{"type":"null"}]},"over":{"type":"array","items":{"type":"string","x-extensible-enum":["customers","storage","members","stores"]}},"near":{"type":"array","items":{"type":"string","x-extensible-enum":["customers","storage"]}},"since":{"anyOf":[{"type":"string"},{"type":"null"}]},"unlocks_pause_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"suspend_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"delete_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"hold_until":{"anyOf":[{"type":"string"},{"type":"null"}]},"upgrade_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["phase","trigger","over","near","since","unlocks_pause_at","suspend_at","delete_at","hold_until","upgrade_at"]},{"type":"null"}]},"has_customer":{"description":"Whether the business is a customer at Stripe, so its billing portal can open.","type":"boolean"},"fee":{"anyOf":[{"type":"object","properties":{"rate_bps":{"type":"number"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["rate_bps","updated_at"]},{"type":"null"}]},"connections":{"type":"array","items":{"type":"object","properties":{"processor":{"type":"string","x-extensible-enum":["stripe"]},"external_ref":{"type":"string"},"status":{"type":"string","x-extensible-enum":["past_due","enabled","onboard","currently_due"]},"enabled":{"type":"boolean"},"held":{"type":"boolean"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["processor","external_ref","status","enabled","held","updated_at"]}},"stores":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"locale":{"type":"string"},"location":{"anyOf":[{"type":"string","x-extensible-enum":["wnam","enam","sam","weur","eeur","apac","apac-ne","apac-se","oc","afr","me"]},{"type":"null"}]},"hostname":{"anyOf":[{"type":"string"},{"type":"null"}]},"swatch":{"anyOf":[{"type":"string","x-extensible-enum":["emerald","blue","teal","indigo","purple","pink","red","orange","yellow","gray"]},{"type":"null"}]},"icon":{"type":"string"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","locale","location","hostname","swatch","icon","created_at"]}},"total":{"type":"number"},"limit":{"type":"number"}},"required":["items","total","limit"]},"members":{"type":"object","properties":{"total":{"type":"number"},"limit":{"type":"number"}},"required":["total","limit"]},"id":{"type":"string"},"name":{"type":"string"},"short_name":{"type":"string"},"email":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"swatch":{"anyOf":[{"type":"string","x-extensible-enum":["emerald","blue","teal","indigo","purple","pink","red","orange","yellow","gray"]},{"type":"null"}]},"logo":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["plan","base_plan","standing","has_customer","fee","connections","stores","members","id","name","short_name","email","description","swatch","logo","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"patch":{"operationId":"updateOrganization","summary":"Updates the business's name and details.","tags":["organization"],"security":[{"bearer":["organization:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Updates the business's name and details.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"plan":{"anyOf":[{"type":"object","properties":{"plan":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier":{"type":"string","x-extensible-enum":["none","lite","pro","enterprise"]},"price_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"interval":{"anyOf":[{"type":"string","x-extensible-enum":["month","year"]},{"type":"null"}]},"quantity":{"type":"number"},"scheduled_quantity":{"anyOf":[{"type":"number"},{"type":"null"}]},"scheduled_plan":{"anyOf":[{"type":"string"},{"type":"null"}]},"scheduled_price_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"scheduled_interval":{"anyOf":[{"type":"string","x-extensible-enum":["month","year"]},{"type":"null"}]},"scheduled_releases":{"type":"number"},"scheduled_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"pending_switch":{"anyOf":[{"type":"object","properties":{"plan":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"interval":{"anyOf":[{"type":"string","x-extensible-enum":["month","year"]},{"type":"null"}]}},"required":["plan","name","interval"]},{"type":"null"}]},"storage_bytes":{"anyOf":[{"type":"number"},{"type":"null"}]},"member_limit":{"anyOf":[{"type":"number"},{"type":"null"}]},"transcription_minutes":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["active","past_due","cancelled"]},"valid_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"valid_until":{"anyOf":[{"type":"string"},{"type":"null"}]},"cancelled_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"trial_ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"source_kind":{"type":"string","x-extensible-enum":["checkout","manual","staff"]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["plan","name","tier","price_ref","interval","quantity","scheduled_quantity","scheduled_plan","scheduled_price_ref","scheduled_interval","scheduled_releases","scheduled_at","pending_switch","storage_bytes","member_limit","transcription_minutes","status","valid_from","valid_until","cancelled_at","trial_ends_at","source_kind","updated_at"]},{"type":"null"}]},"base_plan":{"description":"The plan held for good beneath any bought, whether or not one is live; null for none.","anyOf":[{"type":"object","properties":{"plan":{"description":"The plan's key: a tier, or a product of no tier.","type":"string"},"name":{"description":"Null for a plan of no name of ours.","anyOf":[{"type":"string"},{"type":"null"}]},"tier":{"description":"Whose limits apply.","type":"string","x-extensible-enum":["none","lite","pro","enterprise"]},"granted_at":{"description":"When Sherpo granted it.","type":"string","format":"date-time"},"in_effect":{"description":"Whether it is the plan answered, as no bought plan is live.","type":"boolean"}},"required":["plan","name","tier","granted_at","in_effect"]},{"type":"null"}]},"standing":{"anyOf":[{"type":"object","properties":{"phase":{"type":"string","x-extensible-enum":["suspended","ok","notice","unlocks_paused","deleted"]},"trigger":{"anyOf":[{"type":"string","x-extensible-enum":["over_limit","plan_cancelled","payment_failed","plan_ended","no_plan"]},{"type":"null"}]},"over":{"type":"array","items":{"type":"string","x-extensible-enum":["customers","storage","members","stores"]}},"near":{"type":"array","items":{"type":"string","x-extensible-enum":["customers","storage"]}},"since":{"anyOf":[{"type":"string"},{"type":"null"}]},"unlocks_pause_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"suspend_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"delete_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"hold_until":{"anyOf":[{"type":"string"},{"type":"null"}]},"upgrade_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["phase","trigger","over","near","since","unlocks_pause_at","suspend_at","delete_at","hold_until","upgrade_at"]},{"type":"null"}]},"has_customer":{"description":"Whether the business is a customer at Stripe, so its billing portal can open.","type":"boolean"},"fee":{"anyOf":[{"type":"object","properties":{"rate_bps":{"type":"number"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["rate_bps","updated_at"]},{"type":"null"}]},"connections":{"type":"array","items":{"type":"object","properties":{"processor":{"type":"string","x-extensible-enum":["stripe"]},"external_ref":{"type":"string"},"status":{"type":"string","x-extensible-enum":["past_due","enabled","onboard","currently_due"]},"enabled":{"type":"boolean"},"held":{"type":"boolean"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["processor","external_ref","status","enabled","held","updated_at"]}},"stores":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"locale":{"type":"string"},"location":{"anyOf":[{"type":"string","x-extensible-enum":["wnam","enam","sam","weur","eeur","apac","apac-ne","apac-se","oc","afr","me"]},{"type":"null"}]},"hostname":{"anyOf":[{"type":"string"},{"type":"null"}]},"swatch":{"anyOf":[{"type":"string","x-extensible-enum":["emerald","blue","teal","indigo","purple","pink","red","orange","yellow","gray"]},{"type":"null"}]},"icon":{"type":"string"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","locale","location","hostname","swatch","icon","created_at"]}},"total":{"type":"number"},"limit":{"type":"number"}},"required":["items","total","limit"]},"members":{"type":"object","properties":{"total":{"type":"number"},"limit":{"type":"number"}},"required":["total","limit"]},"id":{"type":"string"},"name":{"type":"string"},"short_name":{"type":"string"},"email":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"swatch":{"anyOf":[{"type":"string","x-extensible-enum":["emerald","blue","teal","indigo","purple","pink","red","orange","yellow","gray"]},{"type":"null"}]},"logo":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["plan","base_plan","standing","has_customer","fee","connections","stores","members","id","name","short_name","email","description","swatch","logo","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"Stored trimmed; a blank one is refused.","type":"string","minLength":1,"maxLength":120},"short_name":{"type":"string","minLength":3,"maxLength":63,"pattern":"^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$"},"email":{"type":"string","minLength":1,"maxLength":254,"pattern":"^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$"},"description":{"anyOf":[{"type":"string","minLength":0,"maxLength":2000},{"type":"null"}]},"swatch":{"anyOf":[{"type":"string","enum":["emerald","blue","teal","indigo","purple","pink","red","orange","yellow","gray"]},{"type":"null"}]}},"additionalProperties":false}}}}}},"/v1/stores/{store}/organization/logo":{"put":{"operationId":"setOrganizationLogo","summary":"Sets or clears the business's logo from a file.","tags":["organization"],"security":[{"bearer":["organization:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Sets or clears the business's logo from a file.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"plan":{"anyOf":[{"type":"object","properties":{"plan":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier":{"type":"string","x-extensible-enum":["none","lite","pro","enterprise"]},"price_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"interval":{"anyOf":[{"type":"string","x-extensible-enum":["month","year"]},{"type":"null"}]},"quantity":{"type":"number"},"scheduled_quantity":{"anyOf":[{"type":"number"},{"type":"null"}]},"scheduled_plan":{"anyOf":[{"type":"string"},{"type":"null"}]},"scheduled_price_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"scheduled_interval":{"anyOf":[{"type":"string","x-extensible-enum":["month","year"]},{"type":"null"}]},"scheduled_releases":{"type":"number"},"scheduled_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"pending_switch":{"anyOf":[{"type":"object","properties":{"plan":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"interval":{"anyOf":[{"type":"string","x-extensible-enum":["month","year"]},{"type":"null"}]}},"required":["plan","name","interval"]},{"type":"null"}]},"storage_bytes":{"anyOf":[{"type":"number"},{"type":"null"}]},"member_limit":{"anyOf":[{"type":"number"},{"type":"null"}]},"transcription_minutes":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["active","past_due","cancelled"]},"valid_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"valid_until":{"anyOf":[{"type":"string"},{"type":"null"}]},"cancelled_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"trial_ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"source_kind":{"type":"string","x-extensible-enum":["checkout","manual","staff"]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["plan","name","tier","price_ref","interval","quantity","scheduled_quantity","scheduled_plan","scheduled_price_ref","scheduled_interval","scheduled_releases","scheduled_at","pending_switch","storage_bytes","member_limit","transcription_minutes","status","valid_from","valid_until","cancelled_at","trial_ends_at","source_kind","updated_at"]},{"type":"null"}]},"base_plan":{"description":"The plan held for good beneath any bought, whether or not one is live; null for none.","anyOf":[{"type":"object","properties":{"plan":{"description":"The plan's key: a tier, or a product of no tier.","type":"string"},"name":{"description":"Null for a plan of no name of ours.","anyOf":[{"type":"string"},{"type":"null"}]},"tier":{"description":"Whose limits apply.","type":"string","x-extensible-enum":["none","lite","pro","enterprise"]},"granted_at":{"description":"When Sherpo granted it.","type":"string","format":"date-time"},"in_effect":{"description":"Whether it is the plan answered, as no bought plan is live.","type":"boolean"}},"required":["plan","name","tier","granted_at","in_effect"]},{"type":"null"}]},"standing":{"anyOf":[{"type":"object","properties":{"phase":{"type":"string","x-extensible-enum":["suspended","ok","notice","unlocks_paused","deleted"]},"trigger":{"anyOf":[{"type":"string","x-extensible-enum":["over_limit","plan_cancelled","payment_failed","plan_ended","no_plan"]},{"type":"null"}]},"over":{"type":"array","items":{"type":"string","x-extensible-enum":["customers","storage","members","stores"]}},"near":{"type":"array","items":{"type":"string","x-extensible-enum":["customers","storage"]}},"since":{"anyOf":[{"type":"string"},{"type":"null"}]},"unlocks_pause_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"suspend_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"delete_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"hold_until":{"anyOf":[{"type":"string"},{"type":"null"}]},"upgrade_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["phase","trigger","over","near","since","unlocks_pause_at","suspend_at","delete_at","hold_until","upgrade_at"]},{"type":"null"}]},"has_customer":{"description":"Whether the business is a customer at Stripe, so its billing portal can open.","type":"boolean"},"fee":{"anyOf":[{"type":"object","properties":{"rate_bps":{"type":"number"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["rate_bps","updated_at"]},{"type":"null"}]},"connections":{"type":"array","items":{"type":"object","properties":{"processor":{"type":"string","x-extensible-enum":["stripe"]},"external_ref":{"type":"string"},"status":{"type":"string","x-extensible-enum":["past_due","enabled","onboard","currently_due"]},"enabled":{"type":"boolean"},"held":{"type":"boolean"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["processor","external_ref","status","enabled","held","updated_at"]}},"stores":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"locale":{"type":"string"},"location":{"anyOf":[{"type":"string","x-extensible-enum":["wnam","enam","sam","weur","eeur","apac","apac-ne","apac-se","oc","afr","me"]},{"type":"null"}]},"hostname":{"anyOf":[{"type":"string"},{"type":"null"}]},"swatch":{"anyOf":[{"type":"string","x-extensible-enum":["emerald","blue","teal","indigo","purple","pink","red","orange","yellow","gray"]},{"type":"null"}]},"icon":{"type":"string"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","locale","location","hostname","swatch","icon","created_at"]}},"total":{"type":"number"},"limit":{"type":"number"}},"required":["items","total","limit"]},"members":{"type":"object","properties":{"total":{"type":"number"},"limit":{"type":"number"}},"required":["total","limit"]},"id":{"type":"string"},"name":{"type":"string"},"short_name":{"type":"string"},"email":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"swatch":{"anyOf":[{"type":"string","x-extensible-enum":["emerald","blue","teal","indigo","purple","pink","red","orange","yellow","gray"]},{"type":"null"}]},"logo":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["plan","base_plan","standing","has_customer","fee","connections","stores","members","id","name","short_name","email","description","swatch","logo","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"image":{"anyOf":[{"type":"string","contentEncoding":"base64"},{"type":"string","contentEncoding":"base64"},{"type":"null"}]}},"required":["image"],"additionalProperties":false}}}}}},"/v1/stores/{store}/balance":{"get":{"operationId":"getBalance","summary":"Reads the business's payout balance.","tags":["organization"],"security":[{"bearer":["organization:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Reads the business's payout balance.","content":{"application/json":{"schema":{"type":"object","properties":{"available":{"type":"array","items":{"type":"object","properties":{"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["amount","currency","exponent"]}},"pending":{"type":"array","items":{"type":"object","properties":{"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["amount","currency","exponent"]}},"in_transit":{"type":"array","items":{"type":"object","properties":{"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["amount","currency","exponent"]}},"next_payouts":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"arrives_at":{"type":"string"}},"required":["currency","arrives_at"]}},"complete":{"type":"boolean"}},"required":["available","pending","in_transit","next_payouts","complete"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/payouts":{"get":{"operationId":"listPayouts","summary":"Lists the business's payouts.","tags":["organization"],"security":[{"bearer":["organization:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^po_[A-Za-z0-9]+$"}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}}],"responses":{"200":{"description":"Lists the business's payouts.","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string"},"method":{"type":"string"},"type":{"type":"string","x-extensible-enum":["card","bank_account"]},"arrives_at":{"type":"string"},"created_at":{"type":"string"},"destination":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"bank_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"last4":{"type":"string"},"currency":{"type":"string"}},"required":["id","bank_name","last4","currency"]},{"type":"object","properties":{"id":{"type":"string"},"bank_name":{"type":"null"},"last4":{"type":"string"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","bank_name","last4","currency"]},{"type":"null"}]},"statement_descriptor":{"anyOf":[{"type":"string"},{"type":"null"}]},"failure_message":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","amount","currency","exponent","status","method","type","arrives_at","created_at","destination","statement_descriptor","failure_message"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/plan_store/preview/query":{"post":{"operationId":"previewPlanStore","summary":"Previews what one more store on the business's plan charges now and bills from its next renewal.","tags":["organization"],"security":[{"bearer":["organization:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Previews what one more store on the business's plan charges now and bills from its next renewal.","content":{"application/json":{"schema":{"type":"object","properties":{"quote":{"type":"string"},"proration_date":{"type":"string"},"expires_at":{"type":"string"},"currency":{"type":"string"},"exponent":{"type":"number"},"amount_due":{"type":"number"},"tax":{"type":"number"},"renewal_amount":{"type":"number"},"renewal_tax":{"type":"number"},"renews_at":{"type":"string"},"trial_ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"plan":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier":{"type":"string","x-extensible-enum":["none","lite","pro","enterprise"]},"interval":{"anyOf":[{"type":"string","x-extensible-enum":["month","year"]},{"type":"null"}]},"interval_count":{"type":"number"},"quantity":{"type":"number"},"limits":{"type":"object","properties":{"storage_bytes":{"type":"number"},"customers":{"anyOf":[{"type":"number","const":0},{"type":"number","const":2500},{"type":"null"}]},"marketing_emails":{"anyOf":[{"type":"number","const":0},{"type":"number","const":50000},{"type":"number","const":100000}]},"members":{"anyOf":[{"type":"number","const":1},{"type":"number","const":200}]},"pages":{"anyOf":[{"type":"number","const":0},{"type":"number","const":30}]},"unbranded":{"type":"boolean"},"domain":{"type":"boolean"},"learning":{"type":"boolean"},"self_hosted":{"type":"boolean"},"ai":{"type":"boolean"},"transcription_minutes":{"type":"number"}},"required":["storage_bytes","customers","marketing_emails","members","pages","unbranded","domain","learning","self_hosted","ai","transcription_minutes"]}},"required":["name","tier","interval","interval_count","quantity","limits"]}},"required":["quote","proration_date","expires_at","currency","exponent","amount_due","tax","renewal_amount","renewal_tax","renews_at","trial_ends_at","plan"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"price":{"description":"The plan as the seller saw it, so a plan changed since is never previewed.","anyOf":[{"type":"string","maxLength":255},{"type":"null"}]},"quantity":{"description":"Stores the plan bills before the one added.","type":"integer","minimum":1,"maximum":10}},"required":["price","quantity"],"additionalProperties":false}}}},"x-read-only":true}},"/v1/stores/{store}/organization/plan/change/preview":{"get":{"operationId":"previewPlanChange","summary":"Previews switching the business's plan to another tier or billing period: when it takes effect, what it charges now and what it renews at, with a quote that holds the amount for 5 minutes. It takes effect now, prorated, when the tier doesn't drop and the period doesn't shorten; any other switch from the period's end.","tags":["organization"],"security":[{"bearer":["organization:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"key","in":"query","required":true,"description":"The plan to switch to, by its price's key: its tier and how often it bills.","schema":{"description":"The plan to switch to, by its price's key: its tier and how often it bills.","type":"string","enum":["lite_monthly","lite_yearly","pro_monthly","pro_yearly"]}}],"responses":{"200":{"description":"Previews switching the business's plan to another tier or billing period: when it takes effect, what it charges now and what it renews at, with a quote that holds the amount for 5 minutes. It takes effect now, prorated, when the tier doesn't drop and the period doesn't shorten; any other switch from the period's end.","content":{"application/json":{"schema":{"type":"object","properties":{"quote":{"type":"string"},"effective":{"type":"string","x-extensible-enum":["now","period_end"]},"effective_at":{"type":"string"},"expires_at":{"type":"string"},"currency":{"type":"string"},"exponent":{"type":"number"},"amount_due":{"type":"number"},"tax":{"type":"number"},"charge":{"type":"number"},"credit":{"type":"number"},"other":{"type":"number"},"renewal_amount":{"type":"number"},"renewal_tax":{"type":"number"},"renews_at":{"type":"string"},"plan":{"type":"object","properties":{"key":{"type":"string","x-extensible-enum":["lite_monthly","lite_yearly","pro_monthly","pro_yearly"]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier":{"type":"string","x-extensible-enum":["lite","pro","enterprise"]},"interval":{"type":"string","x-extensible-enum":["month","year"]},"quantity":{"type":"number"}},"required":["key","name","tier","interval","quantity"]}},"required":["quote","effective","effective_at","expires_at","currency","exponent","amount_due","tax","charge","credit","other","renewal_amount","renewal_tax","renews_at","plan"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/organization/plan/change":{"post":{"operationId":"changePlan","summary":"Switches the business's plan to the one a preview quoted: now, charged at once at the quoted amount and applied only once paid, or from the period's end. A charge the card holder must confirm answers what to confirm it with. Not past a plan held for good, nor to Lite over its limits. Only a member with full access switches.","tags":["organization"],"security":[{"bearer":["organization:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Switches the business's plan to the one a preview quoted: now, charged at once at the quoted amount and applied only once paid, or from the period's end. A charge the card holder must confirm answers what to confirm it with. Not past a plan held for good, nor to Lite over its limits. Only a member with full access switches.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"plan":{"anyOf":[{"type":"object","properties":{"plan":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier":{"type":"string","x-extensible-enum":["none","lite","pro","enterprise"]},"price_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"interval":{"anyOf":[{"type":"string","x-extensible-enum":["month","year"]},{"type":"null"}]},"quantity":{"type":"number"},"scheduled_quantity":{"anyOf":[{"type":"number"},{"type":"null"}]},"scheduled_plan":{"anyOf":[{"type":"string"},{"type":"null"}]},"scheduled_price_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"scheduled_interval":{"anyOf":[{"type":"string","x-extensible-enum":["month","year"]},{"type":"null"}]},"scheduled_releases":{"type":"number"},"scheduled_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"pending_switch":{"anyOf":[{"type":"object","properties":{"plan":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"interval":{"anyOf":[{"type":"string","x-extensible-enum":["month","year"]},{"type":"null"}]}},"required":["plan","name","interval"]},{"type":"null"}]},"storage_bytes":{"anyOf":[{"type":"number"},{"type":"null"}]},"member_limit":{"anyOf":[{"type":"number"},{"type":"null"}]},"transcription_minutes":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["active","past_due","cancelled"]},"valid_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"valid_until":{"anyOf":[{"type":"string"},{"type":"null"}]},"cancelled_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"trial_ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"source_kind":{"type":"string","x-extensible-enum":["checkout","manual","staff"]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["plan","name","tier","price_ref","interval","quantity","scheduled_quantity","scheduled_plan","scheduled_price_ref","scheduled_interval","scheduled_releases","scheduled_at","pending_switch","storage_bytes","member_limit","transcription_minutes","status","valid_from","valid_until","cancelled_at","trial_ends_at","source_kind","updated_at"]},{"type":"null"}]},"confirm":{"anyOf":[{"type":"object","properties":{"client_secret":{"type":"string"},"publishable_key":{"type":"string"}},"required":["client_secret","publishable_key"]},{"type":"null"}]}},"required":["plan","confirm"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"description":"The plan to switch to, as previewed.","type":"string","enum":["lite_monthly","lite_yearly","pro_monthly","pro_yearly"]},"quote":{"description":"The quote `previewPlanChange` answered, whose amount is the one charged.","type":"string","maxLength":4096}},"required":["key","quote"],"additionalProperties":false}}}}},"delete":{"operationId":"cancelPlanChange","summary":"Cancels a plan switch scheduled for the period's end, so the plan renews as it is. A store slot's removal is cancelled on its own. Only a member with full access cancels it.","tags":["organization"],"security":[{"bearer":["organization:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Cancels a plan switch scheduled for the period's end, so the plan renews as it is. A store slot's removal is cancelled on its own. Only a member with full access cancels it.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"plan":{"type":"object","properties":{"plan":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier":{"type":"string","x-extensible-enum":["none","lite","pro","enterprise"]},"price_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"interval":{"anyOf":[{"type":"string","x-extensible-enum":["month","year"]},{"type":"null"}]},"quantity":{"type":"number"},"scheduled_quantity":{"anyOf":[{"type":"number"},{"type":"null"}]},"scheduled_plan":{"anyOf":[{"type":"string"},{"type":"null"}]},"scheduled_price_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"scheduled_interval":{"anyOf":[{"type":"string","x-extensible-enum":["month","year"]},{"type":"null"}]},"scheduled_releases":{"type":"number"},"scheduled_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"pending_switch":{"anyOf":[{"type":"object","properties":{"plan":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"interval":{"anyOf":[{"type":"string","x-extensible-enum":["month","year"]},{"type":"null"}]}},"required":["plan","name","interval"]},{"type":"null"}]},"storage_bytes":{"anyOf":[{"type":"number"},{"type":"null"}]},"member_limit":{"anyOf":[{"type":"number"},{"type":"null"}]},"transcription_minutes":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["active","past_due","cancelled"]},"valid_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"valid_until":{"anyOf":[{"type":"string"},{"type":"null"}]},"cancelled_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"trial_ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"source_kind":{"type":"string","x-extensible-enum":["checkout","manual","staff"]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["plan","name","tier","price_ref","interval","quantity","scheduled_quantity","scheduled_plan","scheduled_price_ref","scheduled_interval","scheduled_releases","scheduled_at","pending_switch","storage_bytes","member_limit","transcription_minutes","status","valid_from","valid_until","cancelled_at","trial_ends_at","source_kind","updated_at"]}},"required":["plan"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/organization/plan/change/confirm":{"post":{"operationId":"confirmPlanChange","summary":"Finishes a plan switch whose charge waited on its card holder, charging nothing more: the plan once paid, or the charge voided when it was not confirmed. Only a member with full access finishes it.","tags":["organization"],"security":[{"bearer":["organization:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Finishes a plan switch whose charge waited on its card holder, charging nothing more: the plan once paid, or the charge voided when it was not confirmed. Only a member with full access finishes it.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"plan":{"anyOf":[{"type":"object","properties":{"plan":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier":{"type":"string","x-extensible-enum":["none","lite","pro","enterprise"]},"price_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"interval":{"anyOf":[{"type":"string","x-extensible-enum":["month","year"]},{"type":"null"}]},"quantity":{"type":"number"},"scheduled_quantity":{"anyOf":[{"type":"number"},{"type":"null"}]},"scheduled_plan":{"anyOf":[{"type":"string"},{"type":"null"}]},"scheduled_price_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"scheduled_interval":{"anyOf":[{"type":"string","x-extensible-enum":["month","year"]},{"type":"null"}]},"scheduled_releases":{"type":"number"},"scheduled_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"pending_switch":{"anyOf":[{"type":"object","properties":{"plan":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"interval":{"anyOf":[{"type":"string","x-extensible-enum":["month","year"]},{"type":"null"}]}},"required":["plan","name","interval"]},{"type":"null"}]},"storage_bytes":{"anyOf":[{"type":"number"},{"type":"null"}]},"member_limit":{"anyOf":[{"type":"number"},{"type":"null"}]},"transcription_minutes":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["active","past_due","cancelled"]},"valid_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"valid_until":{"anyOf":[{"type":"string"},{"type":"null"}]},"cancelled_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"trial_ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"source_kind":{"type":"string","x-extensible-enum":["checkout","manual","staff"]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["plan","name","tier","price_ref","interval","quantity","scheduled_quantity","scheduled_plan","scheduled_price_ref","scheduled_interval","scheduled_releases","scheduled_at","pending_switch","storage_bytes","member_limit","transcription_minutes","status","valid_from","valid_until","cancelled_at","trial_ends_at","source_kind","updated_at"]},{"type":"null"}]},"confirm":{"anyOf":[{"type":"object","properties":{"client_secret":{"type":"string"},"publishable_key":{"type":"string"}},"required":["client_secret","publishable_key"]},{"type":"null"}]}},"required":["plan","confirm"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"description":"The plan the switch waiting moves to, checked against it; any switch waiting when left out.","type":"string","enum":["lite_monthly","lite_yearly","pro_monthly","pro_yearly"]},"confirmed":{"description":"False when the card holder didn't confirm, so a charge still waiting is voided; true by default.","type":"boolean"}},"additionalProperties":false}}}}}},"/v1/stores/{store}/organization/auto_upgrade":{"put":{"operationId":"setAutoUpgrade","summary":"Turns on or off upgrading automatically when the business goes over a limit: a Lite plan over its customers, storage or members moves to Pro 7 days after it crosses unless it gets back under, with Pro's price prorated to the card on file. Off by default; never for a cancelled plan, a free trial or a failed payment.","tags":["organization"],"security":[{"bearer":["organization:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Turns on or off upgrading automatically when the business goes over a limit: a Lite plan over its customers, storage or members moves to Pro 7 days after it crosses unless it gets back under, with Pro's price prorated to the card on file. Off by default; never for a cancelled plan, a free trial or a failed payment.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"auto_upgrade":{"type":"boolean"}},"required":["auto_upgrade"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"description":"Upgrade automatically when the business goes over a limit, off by default: a Lite plan over its customers, storage or members moves to Pro 7 days after it crosses unless it gets back under, at Pro's price for the same period with the prorated charge on the card on file.\nPages, menu items, redirects and too many stores never trigger it, and it never applies to a cancelled plan, a free trial or a failed payment.\nA refused charge goes on with the over-limit steps and emails the owner to upgrade by hand. Only a member with full access sets it.","type":"boolean"}},"required":["enabled"],"additionalProperties":false}}}}}},"/v1/stores/{store}/organization/auto_add_ons":{"put":{"operationId":"setAutoAddOns","summary":"Turns on or off adding Pro's add-on blocks on their own: when a store's storage or AI media minutes would pass what the plan and the blocks held cover, a block of 100 GB or 600 minutes a month is added, $10 a month, charged at once prorated on the card on file. Only ever adds; never during a free trial. Off, uploads and transcriptions stop at what's covered. On by default for new businesses.","tags":["organization"],"security":[{"bearer":["organization:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Turns on or off adding Pro's add-on blocks on their own: when a store's storage or AI media minutes would pass what the plan and the blocks held cover, a block of 100 GB or 600 minutes a month is added, $10 a month, charged at once prorated on the card on file. Only ever adds; never during a free trial. Off, uploads and transcriptions stop at what's covered. On by default for new businesses.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"auto_add_ons":{"type":"boolean"}},"required":["auto_add_ons"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"description":"Add the blocks usage needs past what's covered, each charged at once, prorated, on the card on file; only ever adds.\nOff, uploads and transcriptions stop at what's covered. Kept on Lite for Pro. Only a member with full access sets it.","type":"boolean"}},"required":["enabled"],"additionalProperties":false}}}}}},"/v1/stores/{store}/notifications":{"get":{"operationId":"listNotifications","summary":"Pages the store's customer notifications.","tags":["organization"],"security":[{"bearer":["organization:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["event"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Pages the store's customer notifications.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"event":{"type":"string"},"target":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry"]},"id":{"type":"string"}},"required":["kind","id"]},{"type":"null"}]},"locale":{"type":"string"},"channel":{"type":"string","x-extensible-enum":["email"]},"enabled":{"type":"boolean"},"in_effect":{"type":"boolean"}},"required":["id","event","target","locale","channel","enabled","in_effect"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"post":{"operationId":"createNotification","summary":"Creates a customer notification for an event.","tags":["organization"],"security":[{"bearer":["organization:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"201":{"description":"Creates a customer notification for an event.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"event":{"type":"string"},"target":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry"]},"id":{"type":"string"}},"required":["kind","id"]},{"type":"null"}]},"locale":{"type":"string"},"channel":{"type":"string","x-extensible-enum":["email"]},"enabled":{"type":"boolean"},"in_effect":{"type":"boolean"}},"required":["id","event","target","locale","channel","enabled","in_effect"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"event":{"type":"string","enum":["products.unlocked","request.received","request.waitlisted","request.approved","request.declined","request.expired","request.payment_due","discounts.unlocked","refund.processed","affiliate.earned","subscription.created","subscription.renewed","subscription.reminder","subscription.plan_changed","subscription.payment_failed","subscription.past_due","subscription.unpaid","subscription.canceled","subscription.reactivated","event.registered","event.updated","event.canceled","event.purchase_canceled","event.refund_failed"]},"target":{"anyOf":[{"type":"object","properties":{"kind":{"description":"`entry` only for an event whose mail concerns a lesson or article, which none does yet.","type":"string","enum":["product","entry"]},"id":{"type":"string","minLength":1,"maxLength":512}},"required":["kind","id"],"additionalProperties":false},{"type":"null"}]},"locale":{"type":"string","minLength":1,"maxLength":5,"pattern":"^[a-z]{2}(?:-[A-Z]{2})?$"},"channel":{"description":"Only `email`: `webhook` is refused, since webhooks are endpoints of their own.","type":"string","enum":["email","webhook"]},"enabled":{"type":"boolean"}},"required":["event"],"additionalProperties":false}}}}}},"/v1/stores/{store}/notifications/{notification}":{"patch":{"operationId":"updateNotification","summary":"Updates whether a notification is enabled.","tags":["organization"],"security":[{"bearer":["organization:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"notification","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Updates whether a notification is enabled.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"event":{"type":"string"},"target":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product","entry"]},"id":{"type":"string"}},"required":["kind","id"]},{"type":"null"}]},"locale":{"type":"string"},"channel":{"type":"string","x-extensible-enum":["email"]},"enabled":{"type":"boolean"},"in_effect":{"type":"boolean"}},"required":["id","event","target","locale","channel","enabled","in_effect"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"}},"additionalProperties":false}}}}},"delete":{"operationId":"deleteNotification","summary":"Deletes a notification; the store's defaults are turned off instead.","tags":["organization"],"security":[{"bearer":["organization:delete"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"notification","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Deletes a notification; the store's defaults are turned off instead.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean","const":true}},"required":["id","deleted"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/webhooks":{"get":{"operationId":"listWebhooks","summary":"Pages the store's webhook endpoints.","tags":["organization"],"security":[{"bearer":["organization:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["created"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"search","in":"query","schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Pages the store's webhook endpoints.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"events":{"type":"array","items":{"type":"string"}},"enabled":{"type":"boolean"},"connection_ended_at":{"description":"When it was turned off because the connection that set it up ended.","anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","url","description","events","enabled","connection_ended_at","created_at","updated_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"post":{"operationId":"createWebhook","summary":"Creates a webhook endpoint and answers its signing secret, which no read answers again. Its events need the read scopes their payloads carry.","tags":["organization"],"security":[{"bearer":["organization:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"201":{"description":"Creates a webhook endpoint and answers its signing secret, which no read answers again. Its events need the read scopes their payloads carry.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"webhook":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"events":{"type":"array","items":{"type":"string"}},"enabled":{"type":"boolean"},"connection_ended_at":{"description":"When it was turned off because the connection that set it up ended.","anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","url","description","events","enabled","connection_ended_at","created_at","updated_at"]},"secret":{"type":"string"}},"required":["webhook","secret"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"An `https` URL on a public host; redirects are never followed.","type":"string","minLength":1,"maxLength":2048},"events":{"description":"The events it is sent.","type":"array","items":{"type":"string","enum":["products.unlocked","request.received","request.waitlisted","request.approved","request.declined","request.expired","request.payment_due","discounts.unlocked","refund.processed","affiliate.earned","subscription.created","subscription.renewed","subscription.reminder","subscription.plan_changed","subscription.payment_failed","subscription.past_due","subscription.unpaid","subscription.canceled","subscription.reactivated","event.registered","event.updated","event.canceled","event.purchase_canceled","event.refund_failed","access.revoked","order.created","order.refunded","review.created","grant.revoked","certificate.issued","license.issued","license.disabled","license.enabled","license.replaced","license.activated","license.deactivated","license.limit_reached","customer.created"]},"minItems":1,"maxItems":38},"description":{"anyOf":[{"type":"string","minLength":1,"maxLength":500},{"type":"null"}]},"enabled":{"type":"boolean"}},"required":["url","events"],"additionalProperties":false}}}}}},"/v1/stores/{store}/webhooks/{webhook}":{"get":{"operationId":"getWebhook","summary":"Reads one webhook endpoint, never its secret.","tags":["organization"],"security":[{"bearer":["organization:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"webhook","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Reads one webhook endpoint, never its secret.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"events":{"type":"array","items":{"type":"string"}},"enabled":{"type":"boolean"},"connection_ended_at":{"description":"When it was turned off because the connection that set it up ended.","anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","url","description","events","enabled","connection_ended_at","created_at","updated_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"patch":{"operationId":"updateWebhook","summary":"Updates a webhook endpoint: its URL, events, description or whether it is sent anything. A new URL or added events need the read scopes the events' payloads carry.","tags":["organization"],"security":[{"bearer":["organization:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"webhook","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Updates a webhook endpoint: its URL, events, description or whether it is sent anything. A new URL or added events need the read scopes the events' payloads carry.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"events":{"type":"array","items":{"type":"string"}},"enabled":{"type":"boolean"},"connection_ended_at":{"description":"When it was turned off because the connection that set it up ended.","anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","url","description","events","enabled","connection_ended_at","created_at","updated_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"An `https` URL on a public host; redirects are never followed.","type":"string","minLength":1,"maxLength":2048},"events":{"description":"The events it is sent.","type":"array","items":{"type":"string","enum":["products.unlocked","request.received","request.waitlisted","request.approved","request.declined","request.expired","request.payment_due","discounts.unlocked","refund.processed","affiliate.earned","subscription.created","subscription.renewed","subscription.reminder","subscription.plan_changed","subscription.payment_failed","subscription.past_due","subscription.unpaid","subscription.canceled","subscription.reactivated","event.registered","event.updated","event.canceled","event.purchase_canceled","event.refund_failed","access.revoked","order.created","order.refunded","review.created","grant.revoked","certificate.issued","license.issued","license.disabled","license.enabled","license.replaced","license.activated","license.deactivated","license.limit_reached","customer.created"]},"minItems":1,"maxItems":38},"description":{"anyOf":[{"type":"string","minLength":1,"maxLength":500},{"type":"null"}]},"enabled":{"type":"boolean"}},"additionalProperties":false}}}}},"delete":{"operationId":"deleteWebhook","summary":"Deletes a webhook endpoint and its delivery history.","tags":["organization"],"security":[{"bearer":["organization:delete"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"webhook","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Deletes a webhook endpoint and its delivery history.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean","const":true}},"required":["id","deleted"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/webhooks/{webhook}/secret/roll":{"post":{"operationId":"rollWebhookSecret","summary":"Replaces a webhook endpoint's signing secret and answers the new one once; the old one signs nothing more. Needs the read scopes of its events and of every event it still owes.","tags":["organization"],"security":[{"bearer":["organization:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"webhook","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Replaces a webhook endpoint's signing secret and answers the new one once; the old one signs nothing more. Needs the read scopes of its events and of every event it still owes.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"webhook":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"events":{"type":"array","items":{"type":"string"}},"enabled":{"type":"boolean"},"connection_ended_at":{"description":"When it was turned off because the connection that set it up ended.","anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","url","description","events","enabled","connection_ended_at","created_at","updated_at"]},"secret":{"type":"string"}},"required":["webhook","secret"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}}}},"/v1/stores/{store}/webhook_deliveries":{"get":{"operationId":"listWebhookDeliveries","summary":"Pages a webhook endpoint's recent deliveries: status, attempts and last response code.","tags":["organization"],"security":[{"bearer":["organization:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["created"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Pages a webhook endpoint's recent deliveries: status, attempts and last response code.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"webhook_id":{"type":"string"},"event_id":{"type":"string"},"event":{"type":"string"},"status":{"type":"string","x-extensible-enum":["pending","failed","succeeded"]},"attempts":{"type":"number"},"response_status":{"anyOf":[{"type":"number"},{"type":"null"}]},"last_error":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string"},"next_attempt_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"waiting":{"anyOf":[{"type":"string","x-extensible-enum":["store","dns"]},{"type":"null"}]},"stuck":{"type":"boolean"},"undone":{"type":"boolean"},"settled_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","webhook_id","event_id","event","status","attempts","response_status","last_error","created_at","next_attempt_at","waiting","stuck","undone","settled_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/webhook_deliveries/{delivery}/resend":{"post":{"operationId":"resendWebhookDelivery","summary":"Sends a delivery's event to its endpoint again, with the same event id; needs the read scopes its payload carries.","tags":["organization"],"security":[{"bearer":["organization:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"delivery","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Sends a delivery's event to its endpoint again, with the same event id; needs the read scopes its payload carries.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"webhook_id":{"type":"string"},"event_id":{"type":"string"},"event":{"type":"string"},"status":{"type":"string","x-extensible-enum":["pending","failed","succeeded"]},"attempts":{"type":"number"},"response_status":{"anyOf":[{"type":"number"},{"type":"null"}]},"last_error":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string"},"next_attempt_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"waiting":{"anyOf":[{"type":"string","x-extensible-enum":["store","dns"]},{"type":"null"}]},"stuck":{"type":"boolean"},"undone":{"type":"boolean"},"settled_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","webhook_id","event_id","event","status","attempts","response_status","last_error","created_at","next_attempt_at","waiting","stuck","undone","settled_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}}}},"/v1/stores/{store}/redirects":{"get":{"operationId":"listRedirects","summary":"Pages the store's redirects.","tags":["site"],"security":[{"bearer":["site:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["path"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"search","in":"query","schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Pages the store's redirects.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"from_path":{"type":"string"},"to_path":{"type":"string"},"status":{"type":"number"},"enabled":{"type":"boolean"},"live":{"description":"Resolved: enabled and within the redirects of its kind the plan applies.","type":"boolean"},"connection_ended_at":{"description":"When it was turned off because the connection that set it up ended.","anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","from_path","to_path","status","enabled","live","connection_ended_at","created_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"post":{"operationId":"createRedirect","summary":"Creates a redirect from a path.","tags":["site"],"security":[{"bearer":["site:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"201":{"description":"Creates a redirect from a path.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"from_path":{"type":"string"},"to_path":{"type":"string"},"status":{"type":"number"},"enabled":{"type":"boolean"},"live":{"description":"Resolved: enabled and within the redirects of its kind the plan applies.","type":"boolean"},"connection_ended_at":{"description":"When it was turned off because the connection that set it up ended.","anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","from_path","to_path","status","enabled","live","connection_ended_at","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"from_path":{"type":"string","minLength":1,"maxLength":2000,"pattern":"^/[^\\s?#]*$"},"to_path":{"type":"string","minLength":1,"maxLength":2000,"pattern":"^(?:/[^\\s\\x00-\\x1F\\x7F-\\x9F]*|https?://[^\\s\\x00-\\x1F\\x7F-\\x9F]+)$"},"status":{"anyOf":[{"type":"number","const":308},{"type":"number","const":301},{"type":"number","const":302},{"type":"number","const":307}]},"enabled":{"description":"Off keeps it but never resolves it.","type":"boolean"}},"required":["from_path","to_path"],"additionalProperties":false}}}}}},"/v1/stores/{store}/redirects/{redirect}":{"patch":{"operationId":"updateRedirect","summary":"Updates a redirect's source or destination.","tags":["site"],"security":[{"bearer":["site:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"redirect","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Updates a redirect's source or destination.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"from_path":{"type":"string"},"to_path":{"type":"string"},"status":{"type":"number"},"enabled":{"type":"boolean"},"live":{"description":"Resolved: enabled and within the redirects of its kind the plan applies.","type":"boolean"},"connection_ended_at":{"description":"When it was turned off because the connection that set it up ended.","anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","from_path","to_path","status","enabled","live","connection_ended_at","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"from_path":{"type":"string","minLength":1,"maxLength":2000,"pattern":"^/[^\\s?#]*$"},"to_path":{"type":"string","minLength":1,"maxLength":2000,"pattern":"^(?:/[^\\s\\x00-\\x1F\\x7F-\\x9F]*|https?://[^\\s\\x00-\\x1F\\x7F-\\x9F]+)$"},"status":{"anyOf":[{"type":"number","const":308},{"type":"number","const":301},{"type":"number","const":302},{"type":"number","const":307}]},"enabled":{"description":"Off keeps it but never resolves it.","type":"boolean"}},"additionalProperties":false}}}}},"delete":{"operationId":"deleteRedirect","summary":"Deletes a redirect.","tags":["site"],"security":[{"bearer":["site:delete"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"redirect","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Deletes a redirect.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean","const":true}},"required":["id","deleted"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/paths/check":{"get":{"operationId":"checkPath","summary":"Says whether a path is free for a page or redirect.","tags":["site"],"security":[{"bearer":["site:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"kind","in":"query","required":true,"schema":{"type":"string","enum":["product","page","redirect"]}},{"name":"value","in":"query","required":true,"schema":{"type":"string","minLength":0,"maxLength":4096}},{"name":"except","in":"query","schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Says whether a path is free for a page or redirect.","content":{"application/json":{"schema":{"type":"object","properties":{"available":{"type":"boolean"},"reason":{"anyOf":[{"type":"string","x-extensible-enum":["product","page","invalid","home","redirect","reserved"]},{"type":"null"}]},"current":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["available","reason","current"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/integrations":{"get":{"operationId":"listIntegrations","summary":"Lists the store's integrations and their settings.","tags":["integration"],"security":[{"bearer":["integration:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Lists the store's integrations and their settings.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"kind":{"type":"string"},"sets_cookies":{"type":"boolean"},"enabled":{"type":"boolean"},"connection_ended_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"config_schema":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"config":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"secret_set":{"type":"object","properties":{},"additionalProperties":{"type":"boolean"}}},"required":["id","name","description","kind","sets_cookies","enabled","connection_ended_at","config_schema","config","secret_set"]}}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/integrations/{integration}":{"put":{"operationId":"setIntegration","summary":"Sets or clears an integration's settings. Turning on one that sends buyer and order data, or changing where it sends them, needs the read scopes that data carries.","tags":["integration"],"security":[{"bearer":["integration:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"integration","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Sets or clears an integration's settings. Turning on one that sends buyer and order data, or changing where it sends them, needs the read scopes that data carries.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"kind":{"type":"string"},"sets_cookies":{"type":"boolean"},"enabled":{"type":"boolean"},"connection_ended_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"config_schema":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"secret_set":{"type":"object","properties":{},"additionalProperties":{"type":"boolean"}}},"required":["id","name","description","kind","sets_cookies","enabled","connection_ended_at","config_schema","secret_set"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"config":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"enabled":{"type":"boolean"}},"additionalProperties":false}}}}}},"/v1/stores/{store}/automations":{"get":{"operationId":"listAllAutomations","summary":"Pages the store's automations.","tags":["automation"],"security":[{"bearer":["automation:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["created"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"search","in":"query","schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"facets","in":"query","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["trigger_kind"]}}}],"responses":{"200":{"description":"Pages the store's automations.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"trigger":{"anyOf":[{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"product.reviewed"},"product_id":{"type":"string"},"min_rating":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["product","kind","product_id","min_rating"]},{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"product.purchased"},"product_id":{"type":"string"},"price_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"discount_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["product","kind","product_id","price_id","discount_id"]},{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"event.checked_in"},"product_id":{"type":"string"},"session_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["product","kind","product_id","session_id"]}]},"action":{"anyOf":[{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"product.unlock"},"product_id":{"type":"string"}},"required":["product","kind","product_id"]},{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"price.adjust"},"price_id":{"type":"string"},"product_id":{"type":"string"},"fixed_cents":{"anyOf":[{"type":"number"},{"type":"null"}]},"variable_percent":{"anyOf":[{"type":"number"},{"type":"null"}]},"window":{"anyOf":[{"type":"object","properties":{"starts_at":{"type":"string"},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["starts_at","ends_at"]},{"type":"null"}]}},"required":["product","kind","price_id","product_id","fixed_cents","variable_percent","window"]}]},"ended":{"type":"boolean"},"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"paused_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["trigger","action","ended","id","name","paused_at","token_id","created_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"post":{"operationId":"createAutomation","summary":"Creates an automation; an unlock needs customer:write too, a price adjustment discount:write, and each needs the read scope of what it names.","tags":["automation"],"security":[{"bearer":["automation:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"201":{"description":"Creates an automation; an unlock needs customer:write too, a price adjustment discount:write, and each needs the read scope of what it names.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"trigger":{"anyOf":[{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"product.reviewed"},"product_id":{"type":"string"},"min_rating":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["product","kind","product_id","min_rating"]},{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"product.purchased"},"product_id":{"type":"string"},"price_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"discount_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["product","kind","product_id","price_id","discount_id"]},{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"event.checked_in"},"product_id":{"type":"string"},"session_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["product","kind","product_id","session_id"]}]},"action":{"anyOf":[{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"product.unlock"},"product_id":{"type":"string"}},"required":["product","kind","product_id"]},{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"price.adjust"},"price_id":{"type":"string"},"product_id":{"type":"string"},"fixed_cents":{"anyOf":[{"type":"number"},{"type":"null"}]},"variable_percent":{"anyOf":[{"type":"number"},{"type":"null"}]},"window":{"anyOf":[{"type":"object","properties":{"starts_at":{"type":"string"},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["starts_at","ends_at"]},{"type":"null"}]}},"required":["product","kind","price_id","product_id","fixed_cents","variable_percent","window"]}]},"ended":{"type":"boolean"},"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"paused_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["trigger","action","ended","id","name","paused_at","token_id","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"trigger":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"product.purchased"},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]},"price":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"null"}]},"discount":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"null"}]}},"required":["kind","product"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"product.reviewed"},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]},"min_rating":{"anyOf":[{"type":"integer","minimum":1,"maximum":5},{"type":"null"}]}},"required":["kind","product"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"event.checked_in"},"product":{"description":"The event.","anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]},"session":{"description":"One of its sessions; none fires on a check-in at any.","anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"null"}]}},"required":["kind","product"],"additionalProperties":false}]},"action":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"product.unlock"},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]}},"required":["kind","product"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"price.adjust"},"price":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"fixed_cents":{"type":"integer","minimum":0},"variable_percent":{"type":"integer","minimum":0,"maximum":100},"window":{"anyOf":[{"type":"object","properties":{"starts_at":{"type":"string","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})(?:T(\\d{2}):(\\d{2})(?::(\\d{2})(?:\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"},"ends_at":{"anyOf":[{"type":"string","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})(?:T(\\d{2}):(\\d{2})(?::(\\d{2})(?:\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"},{"type":"null"}]}},"required":["starts_at"],"additionalProperties":false},{"type":"null"}]}},"required":["kind","price"],"additionalProperties":false}]}},"required":["trigger","action"],"additionalProperties":false}}}}}},"/v1/stores/{store}/automation_runs":{"get":{"operationId":"listAutomationRuns","summary":"Pages the runs of automations.","tags":["automation"],"security":[{"bearer":["automation:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["occurred"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"facets","in":"query","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["status","trigger_kind"]}}}],"responses":{"200":{"description":"Pages the runs of automations.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"status":{"type":"string","const":"pending"},"result":{"type":"null"},"reason":{"type":"null"},"finished_at":{"type":"null"},"id":{"type":"string"},"automation_id":{"type":"string"},"trigger":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product.purchased","product.reviewed","event.checked_in"]},"id":{"type":"string"}},"required":["kind","id"]},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["customer","status","result","reason","finished_at","id","automation_id","trigger","customer_id","occurred_at"]},{"type":"object","properties":{"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"status":{"type":"string","const":"succeeded"},"result":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["discount","grant"]},"id":{"type":"string"}},"required":["kind","id"]},"reason":{"type":"null"},"finished_at":{"type":"string"},"id":{"type":"string"},"automation_id":{"type":"string"},"trigger":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product.purchased","product.reviewed","event.checked_in"]},"id":{"type":"string"}},"required":["kind","id"]},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["customer","status","result","reason","finished_at","id","automation_id","trigger","customer_id","occurred_at"]},{"type":"object","properties":{"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"status":{"type":"string","const":"skipped"},"result":{"type":"null"},"reason":{"type":"string","x-extensible-enum":["paused","rule changed","customer gone","trigger gone","trigger changed","product gone","category unknown","product is repeatable","already entitled","price gone","takes nothing off","window over","unlocks paused"]},"finished_at":{"type":"string"},"id":{"type":"string"},"automation_id":{"type":"string"},"trigger":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product.purchased","product.reviewed","event.checked_in"]},"id":{"type":"string"}},"required":["kind","id"]},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["customer","status","result","reason","finished_at","id","automation_id","trigger","customer_id","occurred_at"]},{"type":"object","properties":{"customer":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"erased":{"type":"boolean"}},"required":["id","name","email","phone","erased"]},{"type":"null"}]},"status":{"type":"string","const":"failed"},"result":{"type":"null"},"reason":{"type":"string","const":"error"},"finished_at":{"type":"string"},"id":{"type":"string"},"automation_id":{"type":"string"},"trigger":{"type":"object","properties":{"kind":{"type":"string","x-extensible-enum":["product.purchased","product.reviewed","event.checked_in"]},"id":{"type":"string"}},"required":["kind","id"]},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["customer","status","result","reason","finished_at","id","automation_id","trigger","customer_id","occurred_at"]}]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/automations/{automation}":{"get":{"operationId":"getAutomation","summary":"Reads one automation.","tags":["automation"],"security":[{"bearer":["automation:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"automation","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Reads one automation.","content":{"application/json":{"schema":{"type":"object","properties":{"trigger":{"anyOf":[{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"product.reviewed"},"product_id":{"type":"string"},"min_rating":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["product","kind","product_id","min_rating"]},{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"product.purchased"},"product_id":{"type":"string"},"price_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"discount_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["product","kind","product_id","price_id","discount_id"]},{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"event.checked_in"},"product_id":{"type":"string"},"session_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["product","kind","product_id","session_id"]}]},"action":{"anyOf":[{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"product.unlock"},"product_id":{"type":"string"}},"required":["product","kind","product_id"]},{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"price.adjust"},"price_id":{"type":"string"},"product_id":{"type":"string"},"fixed_cents":{"anyOf":[{"type":"number"},{"type":"null"}]},"variable_percent":{"anyOf":[{"type":"number"},{"type":"null"}]},"window":{"anyOf":[{"type":"object","properties":{"starts_at":{"type":"string"},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["starts_at","ends_at"]},{"type":"null"}]}},"required":["product","kind","price_id","product_id","fixed_cents","variable_percent","window"]}]},"ended":{"type":"boolean"},"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"paused_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["trigger","action","ended","id","name","paused_at","token_id","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"patch":{"operationId":"updateAutomation","summary":"Updates an automation's trigger and action; a new trigger or action needs the scopes creating the rule would.","tags":["automation"],"security":[{"bearer":["automation:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"automation","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Updates an automation's trigger and action; a new trigger or action needs the scopes creating the rule would.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"trigger":{"anyOf":[{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"product.reviewed"},"product_id":{"type":"string"},"min_rating":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["product","kind","product_id","min_rating"]},{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"product.purchased"},"product_id":{"type":"string"},"price_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"discount_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["product","kind","product_id","price_id","discount_id"]},{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"event.checked_in"},"product_id":{"type":"string"},"session_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["product","kind","product_id","session_id"]}]},"action":{"anyOf":[{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"product.unlock"},"product_id":{"type":"string"}},"required":["product","kind","product_id"]},{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"price.adjust"},"price_id":{"type":"string"},"product_id":{"type":"string"},"fixed_cents":{"anyOf":[{"type":"number"},{"type":"null"}]},"variable_percent":{"anyOf":[{"type":"number"},{"type":"null"}]},"window":{"anyOf":[{"type":"object","properties":{"starts_at":{"type":"string"},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["starts_at","ends_at"]},{"type":"null"}]}},"required":["product","kind","price_id","product_id","fixed_cents","variable_percent","window"]}]},"ended":{"type":"boolean"},"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"paused_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["trigger","action","ended","id","name","paused_at","token_id","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"trigger":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"product.purchased"},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]},"price":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"null"}]},"discount":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"null"}]}},"required":["kind","product"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"product.reviewed"},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]},"min_rating":{"anyOf":[{"type":"integer","minimum":1,"maximum":5},{"type":"null"}]}},"required":["kind","product"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"event.checked_in"},"product":{"description":"The event.","anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]},"session":{"description":"One of its sessions; none fires on a check-in at any.","anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"null"}]}},"required":["kind","product"],"additionalProperties":false}]},"action":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"product.unlock"},"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":512}},"required":["slug"],"additionalProperties":false}]}},"required":["kind","product"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"price.adjust"},"price":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"fixed_cents":{"type":"integer","minimum":0},"variable_percent":{"type":"integer","minimum":0,"maximum":100},"window":{"anyOf":[{"type":"object","properties":{"starts_at":{"type":"string","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})(?:T(\\d{2}):(\\d{2})(?::(\\d{2})(?:\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"},"ends_at":{"anyOf":[{"type":"string","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})(?:T(\\d{2}):(\\d{2})(?::(\\d{2})(?:\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"},{"type":"null"}]}},"required":["starts_at"],"additionalProperties":false},{"type":"null"}]}},"required":["kind","price"],"additionalProperties":false}]}},"additionalProperties":false}}}}},"delete":{"operationId":"deleteAutomation","summary":"Deletes an automation.","tags":["automation"],"security":[{"bearer":["automation:delete"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"automation","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Deletes an automation.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean","const":true}},"required":["id","deleted"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/automations/{automation}/pause":{"post":{"operationId":"pauseAutomation","summary":"Pauses an automation.","tags":["automation"],"security":[{"bearer":["automation:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"automation","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Pauses an automation.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"trigger":{"anyOf":[{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"product.reviewed"},"product_id":{"type":"string"},"min_rating":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["product","kind","product_id","min_rating"]},{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"product.purchased"},"product_id":{"type":"string"},"price_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"discount_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["product","kind","product_id","price_id","discount_id"]},{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"event.checked_in"},"product_id":{"type":"string"},"session_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["product","kind","product_id","session_id"]}]},"action":{"anyOf":[{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"product.unlock"},"product_id":{"type":"string"}},"required":["product","kind","product_id"]},{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"price.adjust"},"price_id":{"type":"string"},"product_id":{"type":"string"},"fixed_cents":{"anyOf":[{"type":"number"},{"type":"null"}]},"variable_percent":{"anyOf":[{"type":"number"},{"type":"null"}]},"window":{"anyOf":[{"type":"object","properties":{"starts_at":{"type":"string"},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["starts_at","ends_at"]},{"type":"null"}]}},"required":["product","kind","price_id","product_id","fixed_cents","variable_percent","window"]}]},"ended":{"type":"boolean"},"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"paused_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["trigger","action","ended","id","name","paused_at","token_id","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}}}},"/v1/stores/{store}/automations/{automation}/resume":{"post":{"operationId":"resumeAutomation","summary":"Resumes a paused automation; an unlock needs customer:write too, a price adjustment discount:write.","tags":["automation"],"security":[{"bearer":["automation:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"automation","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Resumes a paused automation; an unlock needs customer:write too, a price adjustment discount:write.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"trigger":{"anyOf":[{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"product.reviewed"},"product_id":{"type":"string"},"min_rating":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["product","kind","product_id","min_rating"]},{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"product.purchased"},"product_id":{"type":"string"},"price_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"discount_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["product","kind","product_id","price_id","discount_id"]},{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"event.checked_in"},"product_id":{"type":"string"},"session_id":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["product","kind","product_id","session_id"]}]},"action":{"anyOf":[{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"product.unlock"},"product_id":{"type":"string"}},"required":["product","kind","product_id"]},{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},{"type":"null"}]},"kind":{"type":"string","const":"price.adjust"},"price_id":{"type":"string"},"product_id":{"type":"string"},"fixed_cents":{"anyOf":[{"type":"number"},{"type":"null"}]},"variable_percent":{"anyOf":[{"type":"number"},{"type":"null"}]},"window":{"anyOf":[{"type":"object","properties":{"starts_at":{"type":"string"},"ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["starts_at","ends_at"]},{"type":"null"}]}},"required":["product","kind","price_id","product_id","fixed_cents","variable_percent","window"]}]},"ended":{"type":"boolean"},"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"paused_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"token_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["trigger","action","ended","id","name","paused_at","token_id","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/portfolio":{"get":{"operationId":"getPortfolio","summary":"Reads a portfolio product's book: settings, metrics and value.","tags":["portfolio"],"security":[{"bearer":["portfolio:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Reads a portfolio product's book: settings, metrics and value.","content":{"application/json":{"schema":{"type":"object","properties":{"product":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},"holdings":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"portfolio_id":{"type":"string"},"symbol":{"type":"string"},"shares":{"type":"number"},"avg_cost":{"anyOf":[{"type":"number"},{"type":"null"}]},"cost_currency":{"type":"string"},"cost_exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"price_currency":{"type":"string"},"price_exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"name":{"type":"string"},"symbol_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"removed_note":{"anyOf":[{"type":"string"},{"type":"null"}]},"removed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["id","portfolio_id","symbol","shares","avg_cost","cost_currency","cost_exponent","price_currency","price_exponent","name","symbol_type","currency","note","removed_note","removed_at","updated_at","metadata"]}},"total":{"type":"number"}},"required":["items","total"]},"events":{"type":"number"},"snapshots":{"type":"number"},"id":{"type":"string"},"product_id":{"type":"string"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"settings":{"type":"object","properties":{"show_absolute_values":{"description":"Amounts, not only percentages.","type":"boolean"},"locked_chart_delay":{"type":"string","x-extensible-enum":["week","month","none","current_quarter"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["product","holdings","events","snapshots","id","product_id","currency","exponent","settings","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"patch":{"operationId":"updatePortfolio","summary":"Updates a portfolio's settings.","tags":["portfolio"],"security":[{"bearer":["portfolio:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Updates a portfolio's settings.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"product":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"path":{"description":"The product's storefront path, or null once deleted, since another product may take its slug.","anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The absolute URL on the store's verified hostname, or null before it has one or once deleted.","anyOf":[{"type":"string"},{"type":"null"}]},"title":{"type":"string"},"category":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","slug","path","url","title","category","deleted"]},"holdings":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"portfolio_id":{"type":"string"},"symbol":{"type":"string"},"shares":{"type":"number"},"avg_cost":{"anyOf":[{"type":"number"},{"type":"null"}]},"cost_currency":{"type":"string"},"cost_exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"price_currency":{"type":"string"},"price_exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"name":{"type":"string"},"symbol_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"removed_note":{"anyOf":[{"type":"string"},{"type":"null"}]},"removed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["id","portfolio_id","symbol","shares","avg_cost","cost_currency","cost_exponent","price_currency","price_exponent","name","symbol_type","currency","note","removed_note","removed_at","updated_at","metadata"]}},"total":{"type":"number"}},"required":["items","total"]},"events":{"type":"number"},"snapshots":{"type":"number"},"id":{"type":"string"},"product_id":{"type":"string"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"settings":{"type":"object","properties":{"show_absolute_values":{"description":"Amounts, not only percentages.","type":"boolean"},"locked_chart_delay":{"type":"string","x-extensible-enum":["week","month","none","current_quarter"]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["product","holdings","events","snapshots","id","product_id","currency","exponent","settings","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"settings":{"description":"Merged onto the stored settings; null deletes a key.","type":"object","properties":{"show_absolute_values":{"description":"Amounts, not only percentages.","anyOf":[{"type":"boolean"},{"type":"null"}]},"locked_chart_delay":{"anyOf":[{"type":"string","enum":["week","month","none","current_quarter"]},{"type":"null"}]}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}},"currency":{"description":"Only while the portfolio holds no holding, event or snapshot.","type":"string","minLength":3,"maxLength":3}},"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/portfolio/valuation":{"get":{"operationId":"getPortfolioValuation","summary":"Values a portfolio at live quotes and prices its watchlist.","tags":["portfolio"],"security":[{"bearer":["portfolio:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Values a portfolio at live quotes and prices its watchlist.","content":{"application/json":{"schema":{"type":"object","properties":{"product_id":{"type":"string"},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"as_of":{"type":"string"},"cash":{"anyOf":[{"type":"number"},{"type":"null"}]},"holdings_value":{"type":"number"},"total_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"change_percent":{"anyOf":[{"type":"number"},{"type":"null"}]},"prices_stale":{"type":"boolean"},"failed_types":{"type":"array","items":{"type":"string","x-extensible-enum":["stock","crypto"]}},"holdings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"symbol":{"type":"string"},"symbol_type":{"type":"string","x-extensible-enum":["stock","crypto"]},"name":{"type":"string"},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"shares":{"description":"Scaled by 1e8.","type":"number"},"avg_cost":{"description":"Per share, in `cost_currency`'s minor unit.","anyOf":[{"type":"number"},{"type":"null"}]},"cost_currency":{"description":"The currency the holding's cost was recorded in (`metadata.cost_currency`), else the portfolio's, as for an unknown code.","type":"string"},"cost_exponent":{"description":"`cost_currency`'s exponent, null when central does not know it.","anyOf":[{"type":"number"},{"type":"null"}]},"value":{"description":"At the live price, in the quote's currency's minor unit; null without a quote.","anyOf":[{"type":"number"},{"type":"null"}]},"day_change":{"description":"The position's move today, in the quote's currency's minor unit; null without a fresh change.","anyOf":[{"type":"number"},{"type":"null"}]},"quote":{"anyOf":[{"type":"object","properties":{"price":{"description":"Per share or coin, in the currency's minor unit.","type":"number"},"currency":{"type":"string"},"exponent":{"type":"number"},"change_percent":{"description":"The day's move in percent, null when there is no prior close or the quote is stale.","anyOf":[{"type":"number"},{"type":"null"}]},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}]},"stale":{"description":"Too old to show as live; the price still values the position.","type":"boolean"}},"required":["price","currency","exponent","change_percent","as_of","stale"]},{"type":"null"}]}},"required":["id","symbol","symbol_type","name","note","shares","avg_cost","cost_currency","cost_exponent","value","day_change","quote"]}},"watchlist":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"symbol":{"type":"string"},"symbol_type":{"type":"string","x-extensible-enum":["stock","crypto"]},"name":{"type":"string"},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"was_held":{"description":"Once a position, since sold to zero.","type":"boolean"},"avg_cost":{"description":"The cost per share a once-held symbol keeps, in `cost_currency`'s minor unit; null for one never held.","anyOf":[{"type":"number"},{"type":"null"}]},"cost_currency":{"description":"The currency the holding's cost was recorded in (`metadata.cost_currency`), else the portfolio's, as for an unknown code.","type":"string"},"cost_exponent":{"description":"`cost_currency`'s exponent, null when central does not know it.","anyOf":[{"type":"number"},{"type":"null"}]},"watched_at":{"description":"When it was last put on the watchlist, null for a row no watch event names.","anyOf":[{"type":"string"},{"type":"null"}]},"quote":{"anyOf":[{"type":"object","properties":{"price":{"description":"Per share or coin, in the currency's minor unit.","type":"number"},"currency":{"type":"string"},"exponent":{"type":"number"},"change_percent":{"description":"The day's move in percent, null when there is no prior close or the quote is stale.","anyOf":[{"type":"number"},{"type":"null"}]},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}]},"stale":{"description":"Too old to show as live; the price still values the position.","type":"boolean"}},"required":["price","currency","exponent","change_percent","as_of","stale"]},{"type":"null"}]}},"required":["id","symbol","symbol_type","name","note","was_held","avg_cost","cost_currency","cost_exponent","watched_at","quote"]}}},"required":["product_id","currency","exponent","as_of","cash","holdings_value","total_value","change_percent","prices_stale","failed_types","holdings","watchlist"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/portfolio/holdings":{"get":{"operationId":"listHoldings","summary":"Pages a portfolio's holdings.","tags":["portfolio"],"security":[{"bearer":["portfolio:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["symbol"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"search","in":"query","schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Pages a portfolio's holdings.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"portfolio_id":{"type":"string"},"symbol":{"type":"string"},"shares":{"type":"number"},"avg_cost":{"anyOf":[{"type":"number"},{"type":"null"}]},"cost_currency":{"type":"string"},"cost_exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"price_currency":{"type":"string"},"price_exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"name":{"type":"string"},"symbol_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"removed_note":{"anyOf":[{"type":"string"},{"type":"null"}]},"removed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["id","portfolio_id","symbol","shares","avg_cost","cost_currency","cost_exponent","price_currency","price_exponent","name","symbol_type","currency","note","removed_note","removed_at","updated_at","metadata"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/portfolio/holdings/{holding}":{"patch":{"operationId":"updateHolding","summary":"Updates a holding's note.","tags":["portfolio"],"security":[{"bearer":["portfolio:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"holding","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Updates a holding's note.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"portfolio_id":{"type":"string"},"symbol":{"type":"string"},"shares":{"type":"number"},"avg_cost":{"anyOf":[{"type":"number"},{"type":"null"}]},"cost_currency":{"type":"string"},"cost_exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"price_currency":{"type":"string"},"price_exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"name":{"type":"string"},"symbol_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"removed_note":{"anyOf":[{"type":"string"},{"type":"null"}]},"removed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["id","portfolio_id","symbol","shares","avg_cost","cost_currency","cost_exponent","price_currency","price_exponent","name","symbol_type","currency","note","removed_note","removed_at","updated_at","metadata"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"note":{"anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]}},"additionalProperties":false}}}}}},"/v1/stores/{store}/products/{product}/portfolio/holdings/{holding}/announced_files":{"get":{"operationId":"listAnnouncedFiles","summary":"Lists the files announced with a holding.","tags":["portfolio"],"security":[{"bearer":["portfolio:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"holding","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Lists the files announced with a holding.","content":{"application/json":{"schema":{"type":"object","properties":{"asset_ids":{"type":"array","items":{"type":"string"}}},"required":["asset_ids"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/portfolio/events":{"get":{"operationId":"listPortfolioEvents","summary":"Pages a portfolio's events: trades, cash and notes.","tags":["portfolio"],"security":[{"bearer":["portfolio:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["occurred"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"search","in":"query","schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Pages a portfolio's events: trades, cash and notes.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"portfolio_id":{"type":"string"},"symbol":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"type":"string"},"shares":{"anyOf":[{"type":"number"},{"type":"null"}]},"price":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"effective_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"symbol_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"price_currency":{"type":"string"},"price_exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"allocation":{"anyOf":[{"type":"number"},{"type":"null"}]},"allocation_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"ratio":{"anyOf":[{"type":"object","properties":{"num":{"type":"number"},"den":{"type":"number"}},"required":["num","den"]},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"recorded_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"source":{"description":"`manual` for a member's entry, `auto` for the pipeline.","type":"string","x-extensible-enum":["manual","auto"]},"recorded_by":{"description":"The member who recorded a manual entry.","type":"string"},"file_ids":{"description":"For a file event, the assets it announces on the holding.","type":"array","items":{"type":"string"}},"remediated":{"description":"A later correction stands in for it.","type":"boolean"},"kind":{"description":"For a split, what the ratio alone cannot tell apart.","type":"string","x-extensible-enum":["reverse","forward","stock_dividend"]},"name":{"description":"The instrument's name core resolved when the event was recorded, never a member's.","type":"string"},"notify":{"description":"For a trade, whether the seller asked to notify the customers with access.","type":"boolean"},"price_quoted":{"description":"The price was left empty and took the symbol's latest quote.","type":"boolean"}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["id","portfolio_id","symbol","type","shares","price","amount","note","effective_date","symbol_type","currency","exponent","price_currency","price_exponent","allocation","allocation_change","ratio","occurred_at","recorded_at","metadata"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"post":{"operationId":"recordPortfolioEvent","summary":"Records a trade, cash movement or note in a portfolio.","tags":["portfolio"],"security":[{"bearer":["portfolio:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}}],"responses":{"201":{"description":"Records a trade, cash movement or note in a portfolio.","headers":{"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"portfolio_id":{"type":"string"},"symbol":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"type":"string"},"shares":{"anyOf":[{"type":"number"},{"type":"null"}]},"price":{"anyOf":[{"type":"number"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"effective_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"symbol_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"price_currency":{"type":"string"},"price_exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"allocation":{"anyOf":[{"type":"number"},{"type":"null"}]},"allocation_change":{"anyOf":[{"type":"number"},{"type":"null"}]},"ratio":{"anyOf":[{"type":"object","properties":{"num":{"type":"number"},"den":{"type":"number"}},"required":["num","den"]},{"type":"null"}]},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"recorded_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"type":"object","properties":{"source":{"description":"`manual` for a member's entry, `auto` for the pipeline.","type":"string","x-extensible-enum":["manual","auto"]},"recorded_by":{"description":"The member who recorded a manual entry.","type":"string"},"file_ids":{"description":"For a file event, the assets it announces on the holding.","type":"array","items":{"type":"string"}},"remediated":{"description":"A later correction stands in for it.","type":"boolean"},"kind":{"description":"For a split, what the ratio alone cannot tell apart.","type":"string","x-extensible-enum":["reverse","forward","stock_dividend"]},"name":{"description":"The instrument's name core resolved when the event was recorded, never a member's.","type":"string"},"notify":{"description":"For a trade, whether the seller asked to notify the customers with access.","type":"boolean"},"price_quoted":{"description":"The price was left empty and took the symbol's latest quote.","type":"boolean"}},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}},{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}},{"type":"null"}]}}},{"type":"null"}]}},{"type":"null"}]}}},"required":["id","portfolio_id","symbol","type","shares","price","amount","note","effective_date","symbol_type","currency","exponent","price_currency","price_exponent","allocation","allocation_change","ratio","occurred_at","recorded_at","metadata"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","anyOf":[{"type":"object","properties":{"idempotency_key":{"description":"The recorder's own key for the event: a repeat answers the event it recorded.","anyOf":[{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9_-]+$"},{"type":"null"}]},"type":{"type":"string","const":"file"},"price":{"description":"Per share, in minor units. Left empty on a buy, a sell, a dividend, a watch or a comment naming a symbol, it takes the symbol's latest price when a fresh quote has one, which the answer carries.","anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"symbol":{"type":"string","minLength":1,"maxLength":64},"symbol_type":{"type":"string","enum":["stock","crypto"]},"file_ids":{"description":"For a file event, the assets its holding delivers.","type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1,"maxItems":100}},"required":["type","symbol","symbol_type","file_ids"],"additionalProperties":false},{"type":"object","properties":{"idempotency_key":{"description":"The recorder's own key for the event: a repeat answers the event it recorded.","anyOf":[{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9_-]+$"},{"type":"null"}]},"type":{"type":"string","const":"buy"},"currency":{"description":"What the amounts are in, so a stale send is refused: the portfolio's own; a comment's price may name another.","anyOf":[{"type":"string","minLength":3,"maxLength":3},{"type":"null"}]},"note":{"anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]},"price":{"description":"Per share, in minor units. Left empty on a buy, a sell, a dividend, a watch or a comment naming a symbol, it takes the symbol's latest price when a fresh quote has one, which the answer carries.","anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"notify":{"description":"For a trade, notify every customer with access to the portfolio, in their notifications and by browser push; left out, it notifies nobody.","anyOf":[{"type":"boolean"},{"type":"null"}]},"symbol":{"type":"string","minLength":1,"maxLength":64},"shares":{"type":"integer","minimum":1,"maximum":9007199254740991},"symbol_type":{"type":"string","enum":["stock","crypto"]},"amount":{"type":"null"}},"required":["type","symbol","shares","symbol_type"],"additionalProperties":false},{"type":"object","properties":{"idempotency_key":{"description":"The recorder's own key for the event: a repeat answers the event it recorded.","anyOf":[{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9_-]+$"},{"type":"null"}]},"type":{"type":"string","const":"sell"},"currency":{"description":"What the amounts are in, so a stale send is refused: the portfolio's own; a comment's price may name another.","anyOf":[{"type":"string","minLength":3,"maxLength":3},{"type":"null"}]},"note":{"anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]},"price":{"description":"Per share, in minor units. Left empty on a buy, a sell, a dividend, a watch or a comment naming a symbol, it takes the symbol's latest price when a fresh quote has one, which the answer carries.","anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"notify":{"description":"For a trade, notify every customer with access to the portfolio, in their notifications and by browser push; left out, it notifies nobody.","anyOf":[{"type":"boolean"},{"type":"null"}]},"symbol":{"type":"string","minLength":1,"maxLength":64},"shares":{"type":"integer","minimum":1,"maximum":9007199254740991},"symbol_type":{"type":"string","enum":["stock","crypto"]},"amount":{"type":"null"}},"required":["type","symbol","shares","symbol_type"],"additionalProperties":false},{"type":"object","properties":{"idempotency_key":{"description":"The recorder's own key for the event: a repeat answers the event it recorded.","anyOf":[{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9_-]+$"},{"type":"null"}]},"type":{"type":"string","const":"deposit"},"currency":{"description":"What the amounts are in, so a stale send is refused: the portfolio's own; a comment's price may name another.","anyOf":[{"type":"string","minLength":3,"maxLength":3},{"type":"null"}]},"note":{"anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]},"amount":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["type","amount"],"additionalProperties":false},{"type":"object","properties":{"idempotency_key":{"description":"The recorder's own key for the event: a repeat answers the event it recorded.","anyOf":[{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9_-]+$"},{"type":"null"}]},"type":{"type":"string","const":"withdraw"},"currency":{"description":"What the amounts are in, so a stale send is refused: the portfolio's own; a comment's price may name another.","anyOf":[{"type":"string","minLength":3,"maxLength":3},{"type":"null"}]},"note":{"anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]},"amount":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["type","amount"],"additionalProperties":false},{"type":"object","properties":{"idempotency_key":{"description":"The recorder's own key for the event: a repeat answers the event it recorded.","anyOf":[{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9_-]+$"},{"type":"null"}]},"type":{"type":"string","const":"dividend"},"currency":{"description":"What the amounts are in, so a stale send is refused: the portfolio's own; a comment's price may name another.","anyOf":[{"type":"string","minLength":3,"maxLength":3},{"type":"null"}]},"note":{"anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]},"price":{"description":"Per share, in minor units. Left empty on a buy, a sell, a dividend, a watch or a comment naming a symbol, it takes the symbol's latest price when a fresh quote has one, which the answer carries.","anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"symbol":{"type":"string","minLength":1,"maxLength":64},"amount":{"type":"integer","minimum":1,"maximum":9007199254740991},"symbol_type":{"type":"string","enum":["stock","crypto"]}},"required":["type","symbol","amount","symbol_type"],"additionalProperties":false},{"type":"object","properties":{"idempotency_key":{"description":"The recorder's own key for the event: a repeat answers the event it recorded.","anyOf":[{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9_-]+$"},{"type":"null"}]},"type":{"type":"string","const":"comment"},"symbol":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"null"}]},"currency":{"description":"What the amounts are in, so a stale send is refused: the portfolio's own; a comment's price may name another.","anyOf":[{"type":"string","minLength":3,"maxLength":3},{"type":"null"}]},"price":{"description":"Per share, in minor units. Left empty on a buy, a sell, a dividend, a watch or a comment naming a symbol, it takes the symbol's latest price when a fresh quote has one, which the answer carries.","anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"symbol_type":{"anyOf":[{"type":"string","enum":["stock","crypto"]},{"type":"null"}]},"note":{"type":"string","minLength":1,"maxLength":2000}},"required":["type","note"],"additionalProperties":false},{"type":"object","properties":{"idempotency_key":{"description":"The recorder's own key for the event: a repeat answers the event it recorded.","anyOf":[{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9_-]+$"},{"type":"null"}]},"type":{"type":"string","const":"watch"},"currency":{"description":"What the amounts are in, so a stale send is refused: the portfolio's own; a comment's price may name another.","anyOf":[{"type":"string","minLength":3,"maxLength":3},{"type":"null"}]},"note":{"anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]},"price":{"description":"Per share, in minor units. Left empty on a buy, a sell, a dividend, a watch or a comment naming a symbol, it takes the symbol's latest price when a fresh quote has one, which the answer carries.","anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"symbol":{"type":"string","minLength":1,"maxLength":64},"symbol_type":{"type":"string","enum":["stock","crypto"]}},"required":["type","symbol","symbol_type"],"additionalProperties":false},{"type":"object","properties":{"idempotency_key":{"description":"The recorder's own key for the event: a repeat answers the event it recorded.","anyOf":[{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9_-]+$"},{"type":"null"}]},"type":{"type":"string","const":"unwatch"},"note":{"anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null"}]},"price":{"description":"Per share, in minor units. Left empty on a buy, a sell, a dividend, a watch or a comment naming a symbol, it takes the symbol's latest price when a fresh quote has one, which the answer carries.","anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"symbol":{"type":"string","minLength":1,"maxLength":64},"symbol_type":{"type":"string","enum":["stock","crypto"]}},"required":["type","symbol","symbol_type"],"additionalProperties":false}],"properties":{}}}}}}},"/v1/stores/{store}/products/{product}/portfolio/snapshots":{"get":{"operationId":"listPortfolioSnapshots","summary":"Pages a portfolio's daily snapshots.","tags":["portfolio"],"security":[{"bearer":["portfolio:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["date"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":1000}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Pages a portfolio's daily snapshots.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"value":{"type":"number"},"cash":{"anyOf":[{"type":"number"},{"type":"null"}]},"positions":{"anyOf":[{"type":"number"},{"type":"null"}]},"twr":{"anyOf":[{"type":"number"},{"type":"null"}]},"benchmark":{"anyOf":[{"type":"number"},{"type":"null"}]},"benchmarks":{"type":"object","properties":{"sp500":{"anyOf":[{"type":"number"},{"type":"null"}]},"nasdaq":{"anyOf":[{"type":"number"},{"type":"null"}]},"acwi":{"anyOf":[{"type":"number"},{"type":"null"}]},"gold":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["sp500","nasdaq","acwi","gold"]},"state":{"type":"string","x-extensible-enum":["settled","provisional"]},"currency":{"type":"string"},"exponent":{"anyOf":[{"type":"number"},{"type":"null"}]},"portfolio_id":{"type":"string"},"date":{"type":"string"}},"required":["value","cash","positions","twr","benchmark","benchmarks","state","currency","exponent","portfolio_id","date"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/products/{product}/activity":{"get":{"operationId":"listSoftwareEvents","summary":"Pages a software product's releases and notes, newest first.","tags":["product"],"security":[{"bearer":["product:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"filter","in":"query","style":"deepObject","explode":true,"description":"`filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.","schema":{"type":"object"}},{"name":"sort","in":"query","schema":{"type":"string","enum":["occurred"]}},{"name":"direction","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"cursor","in":"query","schema":{"type":"string","maxLength":8192}},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"search","in":"query","schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Pages a software product's releases and notes, newest first.","headers":{"Link":{"description":"The next page, `<...>; rel=\"next\"`, while `cursor` is not null.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"type":{"description":"`release` or `note`.","type":"string","x-extensible-enum":["note","release"]},"version":{"description":"A release's version; null for a note.","anyOf":[{"type":"string"},{"type":"null"}]},"body":{"description":"The release notes or the note, as plain text.","anyOf":[{"type":"string"},{"type":"null"}]},"current":{"description":"Whether it is the product's current download: its newest release that ships files.","type":"boolean"},"files":{"type":"array","items":{"type":"object","properties":{"attachment_id":{"type":"string"},"asset_id":{"type":"string"},"tier":{"description":"The lowest tier that downloads the file, by its own gate; null for every tier.","anyOf":[{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},{"type":"null"}]},"name":{"type":"string"},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"type":"number"},"description":{"description":"The file's description, as its download shows it to holders; null for none.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["attachment_id","asset_id","tier","name","ext","mime","bytes","description"]}},"tier":{"description":"The lowest tier whose holders download its files, while every file is gated to it; null for every tier.","anyOf":[{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},{"type":"null"}]},"push":{"description":"Its push: `none` never asked, `pending` owed, `sent` to its holders, or `dropped` for good (its files failed, or a newer release came first).","type":"string","x-extensible-enum":["pending","none","sent","dropped"]},"push_reason":{"description":"Why a dropped push was dropped: `superseded`, `files` (failed or never finished), `removed` (they left the release), `unavailable` (the product wasn't open) or `failed`; null otherwise.","anyOf":[{"type":"string","x-extensible-enum":["failed","unavailable","removed","files","superseded"]},{"type":"null"}]},"notified":{"description":"How many holders its push reached so far.","type":"number"},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","product_id","type","version","body","current","files","tier","push","push_reason","notified","occurred_at","created_at","updated_at"]}},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"total":{"type":"number"},"facets":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"number"}}}},"required":["items","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"post":{"operationId":"recordSoftwareEvent","summary":"Records a release, whose files become the current download, or a note on a software product.","tags":["product"],"security":[{"bearer":["product:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"201":{"description":"Records a release, whose files become the current download, or a note on a software product.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"type":{"description":"`release` or `note`.","type":"string","x-extensible-enum":["note","release"]},"version":{"description":"A release's version; null for a note.","anyOf":[{"type":"string"},{"type":"null"}]},"body":{"description":"The release notes or the note, as plain text.","anyOf":[{"type":"string"},{"type":"null"}]},"current":{"description":"Whether it is the product's current download: its newest release that ships files.","type":"boolean"},"files":{"type":"array","items":{"type":"object","properties":{"attachment_id":{"type":"string"},"asset_id":{"type":"string"},"tier":{"description":"The lowest tier that downloads the file, by its own gate; null for every tier.","anyOf":[{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},{"type":"null"}]},"name":{"type":"string"},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"type":"number"},"description":{"description":"The file's description, as its download shows it to holders; null for none.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["attachment_id","asset_id","tier","name","ext","mime","bytes","description"]}},"tier":{"description":"The lowest tier whose holders download its files, while every file is gated to it; null for every tier.","anyOf":[{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},{"type":"null"}]},"push":{"description":"Its push: `none` never asked, `pending` owed, `sent` to its holders, or `dropped` for good (its files failed, or a newer release came first).","type":"string","x-extensible-enum":["pending","none","sent","dropped"]},"push_reason":{"description":"Why a dropped push was dropped: `superseded`, `files` (failed or never finished), `removed` (they left the release), `unavailable` (the product wasn't open) or `failed`; null otherwise.","anyOf":[{"type":"string","x-extensible-enum":["failed","unavailable","removed","files","superseded"]},{"type":"null"}]},"notified":{"description":"How many holders its push reached so far.","type":"number"},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","product_id","type","version","body","current","files","tier","push","push_reason","notified","occurred_at","created_at","updated_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","anyOf":[{"type":"object","properties":{"body":{"description":"The release notes, as plain text.","anyOf":[{"type":"string","minLength":1,"maxLength":10000},{"type":"null"}]},"files":{"description":"The store's files this version ships, in order; each becomes a download of the product.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"maxItems":20},"tier":{"description":"The lowest tier whose holders download its files; null or absent for every tier.","anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"null"}]},"type":{"type":"string","const":"release"},"version":{"description":"As the developer spells it, like `3.2` or `2026.1 beta`.","type":"string","minLength":1,"maxLength":50},"notify":{"description":"Pushes the holders who can download it, once.","type":"boolean"}},"required":["type","version"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"note"},"body":{"description":"The note, as plain text.","type":"string","minLength":1,"maxLength":10000}},"required":["type","body"],"additionalProperties":false}],"properties":{}}}}}}},"/v1/stores/{store}/products/{product}/activity/{event}":{"patch":{"operationId":"updateSoftwareEvent","summary":"Updates a release's version, notes, files or tier, or a note.","tags":["product"],"security":[{"bearer":["product:write"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"event","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Updates a release's version, notes, files or tier, or a note.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"type":{"description":"`release` or `note`.","type":"string","x-extensible-enum":["note","release"]},"version":{"description":"A release's version; null for a note.","anyOf":[{"type":"string"},{"type":"null"}]},"body":{"description":"The release notes or the note, as plain text.","anyOf":[{"type":"string"},{"type":"null"}]},"current":{"description":"Whether it is the product's current download: its newest release that ships files.","type":"boolean"},"files":{"type":"array","items":{"type":"object","properties":{"attachment_id":{"type":"string"},"asset_id":{"type":"string"},"tier":{"description":"The lowest tier that downloads the file, by its own gate; null for every tier.","anyOf":[{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},{"type":"null"}]},"name":{"type":"string"},"ext":{"anyOf":[{"type":"string"},{"type":"null"}]},"mime":{"anyOf":[{"type":"string"},{"type":"null"}]},"bytes":{"type":"number"},"description":{"description":"The file's description, as its download shows it to holders; null for none.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["attachment_id","asset_id","tier","name","ext","mime","bytes","description"]}},"tier":{"description":"The lowest tier whose holders download its files, while every file is gated to it; null for every tier.","anyOf":[{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},{"type":"null"}]},"push":{"description":"Its push: `none` never asked, `pending` owed, `sent` to its holders, or `dropped` for good (its files failed, or a newer release came first).","type":"string","x-extensible-enum":["pending","none","sent","dropped"]},"push_reason":{"description":"Why a dropped push was dropped: `superseded`, `files` (failed or never finished), `removed` (they left the release), `unavailable` (the product wasn't open) or `failed`; null otherwise.","anyOf":[{"type":"string","x-extensible-enum":["failed","unavailable","removed","files","superseded"]},{"type":"null"}]},"notified":{"description":"How many holders its push reached so far.","type":"number"},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","product_id","type","version","body","current","files","tier","push","push_reason","notified","occurred_at","created_at","updated_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"description":"The release notes, as plain text.","anyOf":[{"type":"string","minLength":1,"maxLength":10000},{"type":"null"}]},"files":{"description":"The store's files this version ships, in order; each becomes a download of the product.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},"maxItems":20},"tier":{"description":"The lowest tier whose holders download its files; null or absent for every tier.","anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":512}},"required":["id"],"additionalProperties":false},{"type":"null"}]},"version":{"description":"A release's version.","type":"string","minLength":1,"maxLength":50}},"additionalProperties":false}}}}},"delete":{"operationId":"deleteSoftwareEvent","summary":"Deletes a release, with its files, or a note.","tags":["product"],"security":[{"bearer":["product:delete"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"product","in":"path","required":true,"description":"An id, or `slug:<slug>`.","schema":{"type":"string","minLength":1}},{"name":"event","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"Idempotency-Key","in":"header","description":"Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7E]+$"}}],"responses":{"200":{"description":"Deletes a release, with its files, or a note.","headers":{"Idempotent-Replayed":{"description":"With an `Idempotency-Key`: `true` when this answers an earlier call with the key.","schema":{"type":"string","enum":["true","false"]}},"Cache-Control":{"description":"`no-store`: a write may answer what no read answers again, such as a signing secret.","schema":{"type":"string","enum":["no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean","const":true}},"required":["id","deleted"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/symbols":{"get":{"operationId":"searchSymbols","summary":"Searches the market for symbols by name or ticker.","tags":["portfolio"],"security":[{"bearer":["portfolio:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}},{"name":"query","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"\\S"}},{"name":"symbol_type","in":"query","schema":{"anyOf":[{"type":"string","enum":["stock","crypto"]},{"type":"null"}]}}],"responses":{"200":{"description":"Searches the market for symbols by name or ticker.","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"symbol":{"type":"string"},"name":{"type":"string"},"symbol_type":{"type":"string","x-extensible-enum":["stock","crypto"]},"region":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"description":"The lowercase ISO currency it is listed in, null when the market data names none.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["symbol","name","symbol_type","region","currency"]}}},"required":["items"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/symbols/quotes/query":{"post":{"operationId":"quoteSymbols","summary":"Reads the latest quotes for symbols.","tags":["portfolio"],"security":[{"bearer":["portfolio:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"The store's id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Reads the latest quotes for symbols.","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"symbol":{"type":"string"},"symbol_type":{"type":"string","x-extensible-enum":["stock","crypto"]},"price":{"description":"Per share or coin, in the currency's minor unit.","type":"number"},"currency":{"type":"string"},"exponent":{"type":"number"},"change_percent":{"description":"The day's move in percent, null when there is no prior close or the quote is stale.","anyOf":[{"type":"number"},{"type":"null"}]},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}]},"stale":{"description":"Too old to show as live.","type":"boolean"}},"required":["symbol","symbol_type","price","currency","exponent","change_percent","as_of","stale"]}},"unpriced":{"type":"array","items":{"type":"object","properties":{"symbol":{"type":"string"},"symbol_type":{"type":"string","x-extensible-enum":["stock","crypto"]}},"required":["symbol","symbol_type"]}},"failed_types":{"description":"The types whose read failed, their symbols left unpriced, so a caller can ask again.","type":"array","items":{"type":"string","x-extensible-enum":["stock","crypto"]}}},"required":["items","unpriced","failed_types"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"symbols":{"type":"array","items":{"type":"object","properties":{"symbol":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.^=_&-]{1,32}$"},"symbol_type":{"type":"string","enum":["stock","crypto"]}},"required":["symbol","symbol_type"],"additionalProperties":false},"minItems":1,"maxItems":250}},"required":["symbols"],"additionalProperties":false}}}},"x-read-only":true}},"/v1/merchants":{"get":{"operationId":"listMerchants","summary":"Lists the businesses the token may act for, with their stores; an account token lists them whatever its access.","tags":["organization"],"security":[{"bearer":["organization:read"]}],"parameters":[{"name":"merchant","in":"query","description":"An id.","schema":{"type":"string","minLength":1,"description":"An id."}},{"name":"store","in":"query","description":"An id.","schema":{"type":"string","minLength":1,"description":"An id."}},{"name":"cursor","in":"query","description":"Lists the memberships past a previous page, from that page's `cursor`.","schema":{"description":"Lists the memberships past a previous page, from that page's `cursor`.","type":"string","maxLength":1024}}],"responses":{"200":{"description":"Lists the businesses the token may act for, with their stores; an account token lists them whatever its access.","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"short_name":{"type":"string"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"scopes":{"description":"The scopes their membership spells, not narrowed to the credential presented.","anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"swatch":{"anyOf":[{"type":"string","x-extensible-enum":["emerald","blue","teal","indigo","purple","pink","red","orange","yellow","gray"]},{"type":"null"}]},"logo":{"anyOf":[{"type":"string"},{"type":"null"}]},"stores":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"hostname":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"description":"The store home's absolute URL on its verified hostname, or null before it has one.","anyOf":[{"type":"string"},{"type":"null"}]},"swatch":{"anyOf":[{"type":"string"},{"type":"null"}]},"icon":{"type":"string"}},"required":["id","name","hostname","url","swatch","icon"]}},"total":{"type":"number"}},"required":["items","total"]}},"required":["id","name","short_name","created_at","scopes","swatch","logo","stores"]}},"total":{"type":"number"},"owns_suspended":{"type":"boolean"},"cursor":{"description":"The next page's, null on the last; a page its seats leave empty may still have one.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["items","total","owns_suspended","cursor"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/merchants/{merchant}":{"get":{"operationId":"getMerchant","summary":"Reads one business with its stores.","tags":["organization"],"security":[{"bearer":["organization:read"]}],"parameters":[{"name":"merchant","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Reads one business with its stores.","content":{"application/json":{"schema":{"type":"object","properties":{"plan":{"anyOf":[{"type":"object","properties":{"plan":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier":{"type":"string","x-extensible-enum":["none","lite","pro","enterprise"]},"price_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"interval":{"anyOf":[{"type":"string","x-extensible-enum":["month","year"]},{"type":"null"}]},"quantity":{"type":"number"},"scheduled_quantity":{"anyOf":[{"type":"number"},{"type":"null"}]},"scheduled_plan":{"anyOf":[{"type":"string"},{"type":"null"}]},"scheduled_price_ref":{"anyOf":[{"type":"string"},{"type":"null"}]},"scheduled_interval":{"anyOf":[{"type":"string","x-extensible-enum":["month","year"]},{"type":"null"}]},"scheduled_releases":{"type":"number"},"scheduled_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"pending_switch":{"anyOf":[{"type":"object","properties":{"plan":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"interval":{"anyOf":[{"type":"string","x-extensible-enum":["month","year"]},{"type":"null"}]}},"required":["plan","name","interval"]},{"type":"null"}]},"storage_bytes":{"anyOf":[{"type":"number"},{"type":"null"}]},"member_limit":{"anyOf":[{"type":"number"},{"type":"null"}]},"transcription_minutes":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"type":"string","x-extensible-enum":["active","past_due","cancelled"]},"valid_from":{"anyOf":[{"type":"string"},{"type":"null"}]},"valid_until":{"anyOf":[{"type":"string"},{"type":"null"}]},"cancelled_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"trial_ends_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"source_kind":{"type":"string","x-extensible-enum":["checkout","manual","staff"]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["plan","name","tier","price_ref","interval","quantity","scheduled_quantity","scheduled_plan","scheduled_price_ref","scheduled_interval","scheduled_releases","scheduled_at","pending_switch","storage_bytes","member_limit","transcription_minutes","status","valid_from","valid_until","cancelled_at","trial_ends_at","source_kind","updated_at"]},{"type":"null"}]},"base_plan":{"description":"The plan held for good beneath any bought, whether or not one is live; null for none.","anyOf":[{"type":"object","properties":{"plan":{"description":"The plan's key: a tier, or a product of no tier.","type":"string"},"name":{"description":"Null for a plan of no name of ours.","anyOf":[{"type":"string"},{"type":"null"}]},"tier":{"description":"Whose limits apply.","type":"string","x-extensible-enum":["none","lite","pro","enterprise"]},"granted_at":{"description":"When Sherpo granted it.","type":"string","format":"date-time"},"in_effect":{"description":"Whether it is the plan answered, as no bought plan is live.","type":"boolean"}},"required":["plan","name","tier","granted_at","in_effect"]},{"type":"null"}]},"standing":{"anyOf":[{"type":"object","properties":{"phase":{"type":"string","x-extensible-enum":["suspended","ok","notice","unlocks_paused","deleted"]},"trigger":{"anyOf":[{"type":"string","x-extensible-enum":["over_limit","plan_cancelled","payment_failed","plan_ended","no_plan"]},{"type":"null"}]},"over":{"type":"array","items":{"type":"string","x-extensible-enum":["customers","storage","members","stores"]}},"near":{"type":"array","items":{"type":"string","x-extensible-enum":["customers","storage"]}},"since":{"anyOf":[{"type":"string"},{"type":"null"}]},"unlocks_pause_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"suspend_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"delete_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"hold_until":{"anyOf":[{"type":"string"},{"type":"null"}]},"upgrade_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["phase","trigger","over","near","since","unlocks_pause_at","suspend_at","delete_at","hold_until","upgrade_at"]},{"type":"null"}]},"has_customer":{"description":"Whether the business is a customer at Stripe, so its billing portal can open.","type":"boolean"},"fee":{"anyOf":[{"type":"object","properties":{"rate_bps":{"type":"number"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["rate_bps","updated_at"]},{"type":"null"}]},"connections":{"type":"array","items":{"type":"object","properties":{"processor":{"type":"string","x-extensible-enum":["stripe"]},"external_ref":{"type":"string"},"status":{"type":"string","x-extensible-enum":["past_due","enabled","onboard","currently_due"]},"enabled":{"type":"boolean"},"held":{"type":"boolean"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["processor","external_ref","status","enabled","held","updated_at"]}},"stores":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"locale":{"type":"string"},"location":{"anyOf":[{"type":"string","x-extensible-enum":["wnam","enam","sam","weur","eeur","apac","apac-ne","apac-se","oc","afr","me"]},{"type":"null"}]},"hostname":{"anyOf":[{"type":"string"},{"type":"null"}]},"swatch":{"anyOf":[{"type":"string","x-extensible-enum":["emerald","blue","teal","indigo","purple","pink","red","orange","yellow","gray"]},{"type":"null"}]},"icon":{"type":"string"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","locale","location","hostname","swatch","icon","created_at"]}},"total":{"type":"number"},"limit":{"type":"number"}},"required":["items","total","limit"]},"members":{"type":"object","properties":{"total":{"type":"number"},"limit":{"type":"number"}},"required":["total","limit"]},"id":{"type":"string"},"name":{"type":"string"},"short_name":{"type":"string"},"email":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"swatch":{"anyOf":[{"type":"string","x-extensible-enum":["emerald","blue","teal","indigo","purple","pink","red","orange","yellow","gray"]},{"type":"null"}]},"logo":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["plan","base_plan","standing","has_customer","fee","connections","stores","members","id","name","short_name","email","description","swatch","logo","created_at"]}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","headers":{"WWW-Authenticate":{"description":"On a 401, `Bearer error=\"invalid_token\"`, or `Bearer` alone when no token was sent; on a 403 for a missing scope, `Bearer error=\"insufficient_scope\"`.","schema":{"type":"string"}},"Retry-After":{"description":"On a 429, the seconds until a retry may pass, when known.","schema":{"type":"integer","minimum":0}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/v1/stores/{store}/files/{capability}":{"get":{"operationId":"getFile","summary":"Answers the bytes of a private file a capability names, to the bearer that asked for it.","description":"The URL `POST /assets/{asset}/url` answers for a private file, or a download. Fetch it with the same bearer, before it is refreshed.","tags":["file"],"security":[{"bearer":["file:read"]}],"parameters":[{"name":"store","in":"path","required":true,"description":"A store the token reaches; the file is served from the store its URL was minted for.","schema":{"type":"string"}},{"name":"capability","in":"path","required":true,"description":"The capability in the URL `POST /assets/{asset}/url` answered: the path segment after `/files/`. A file name may follow it as another segment, never inside this one.","schema":{"type":"string","minLength":1}},{"name":"Range","in":"header","required":false,"description":"One byte range of a file shown in place, `bytes={first}-{last}`, `bytes={first}-` or `bytes=-{suffix}`; a download is answered whole.","schema":{"type":"string"}},{"name":"If-Range","in":"header","required":false,"description":"The file's `ETag` from an earlier answer: the range is answered only while the file is unchanged, else the whole file.","schema":{"type":"string"}}],"responses":{"200":{"description":"The file's bytes, with its type and disposition.","headers":{"Accept-Ranges":{"description":"On a file shown in place: it takes a `Range`.","schema":{"type":"string","const":"bytes"}},"ETag":{"description":"On a file shown in place: the file as served, for `If-Range`.","schema":{"type":"string"}}},"content":{"*/*":{"schema":{"type":"string","format":"binary"}}}},"206":{"description":"The range asked for.","headers":{"Content-Range":{"description":"The range served and the length of what it is part of.","schema":{"type":"string"}},"Accept-Ranges":{"schema":{"type":"string","const":"bytes"}},"ETag":{"description":"The file as served, for `If-Range`.","schema":{"type":"string"}}},"content":{"*/*":{"schema":{"type":"string","format":"binary"}}}},"416":{"description":"The range lies outside the file, or is other than one bytes range.","headers":{"Content-Range":{"description":"The length of what it serves, `bytes */{length}`, when it is known.","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"default":{"description":"A problem; see https://api.sherpo.io/merchant/docs/errors.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}}},"components":{"schemas":{"Problem":{"type":"object","properties":{"type":{"type":"string","format":"uri"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"code":{"type":"string"},"context":{"type":"object"},"reached_core":{"type":"boolean"},"core_answer":{"type":"string"}},"required":["type","title","status","detail"]}},"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}}}